Welcome to Website Classin 👋

     
   
   

Website CLassin that provides an optimzed UI with various features in classroom management.

📄 PDF: Link

📄 Slide: Link

🔧 Render Deployment (In progress)

Frontend: https://website-classin-hu7l.onrender.com/

Backend: https://website-classin.onrender.com

🎯 Getting Started

💎 Prerequisites

• Install venv on Linux or WSL(Windows Subsystem for Linux)

sudo apt install python3.10-venv

⚙️ Installation

1. Clone the repo

git clone https://github.com/vihao1802/Website-ClassIn.git

2. From root directory, move to backend

cd backend

3. Init and Set up venv(Virtual Environment) folder

python3 -m venv venv

4. Activate venv

source ./venv/bin/activate

5. Install all packages in requirements.txt

pip install -r ./requirements.txt

6. From root directory, move to frontend

cd frontend

7. Install all required packages in packages.json

npm i

8. Create file .env.local in folder frontend with format:

REACT_APP_BASE_URL=http://localhost:8000/api
REACT_APP_WEBSOCKET_URL=ws://localhost:8000/api/ws

9. Create file .env in folder backend with format:

URL_DATABASE="sqlite:///./classin_database.db"
PORT=8000
DOMAIN_URL=http://localhost:8000
DOMAIN_CLIENT=http:localhost:3000
JWT_ALGORITHM=HS256
JWT_SECRET=#use_generate_UUID_tool_for_this
EMAIL=#email-for-upload-file-feature
PASSWORD_EMAIL=#password-email-for-upload-file-feature
SERVICE_ACCOUNT_FILE=#use-absolute-path-to-backend/config/xenon-timer.json_file

🚀 Usage

⚠️ Use two terminals for running this web application

Frontend(First termnial):

• From root directory

cd frontend

• Run frontend

npm start

Backend(Second termnial):

• From root directory

cd backend

• Run backend

uvicorn main:app --reload

✨ Code Contributors

This project exists thanks to all the people who contribute.

📝 License

Copyright © 2024 Tran Vi Hao.
This project is MIT licensed.