Built using FastAPI, SQLModel, and Alembic.
Please follow the instructions below to set up and run the project locally.
- Python 3.8 or higher
- pip (Python package installer)
To create a virtual environment, navigate to the project directory in your terminal and run:
python -m venv venv- On Windows:
venv\Scripts\activate- On linux or macOS:
source venv/bin/activateInstall the required Python packages using the requirements.txt file:
pip install -r requirements.txtCreate a .env file in the backend directory project. This file will hold the environment variables. You can create the file using a text editor or by running:
touch .envAdd the following lines to the .env file to connect to the database:
DATABASE_URL=<actual database url(e.g.-mysql+pymysql://username:password@host:port/database)>To start the application, use the following command:
uvicorn main:app --host 0.0.0.0 --port 8000 --reloadOnce the application is running, you can access the API documentation using Swagger UI at the following URL: http://localhost:8000/docs
Before you begin, ensure you have the following installed:
- Node.js (v14 or higher)
- npm
Navigate to the project directory:
cd FrontendInstall dependencies: Using npm:
npm installTo start the development server:
npm run devThe application will be available at http://localhost:5173/
frontend/
├── public/ # Public assets (index.html, images, etc.)
├── src/
│ ├── components/ # Reusable components (EventCard, Header, etc.)
│ ├── pages/ # Pages (Home, Login, Signup)
│ ├── store/ # Zustand stores for state management
│ ├── api/ # Axios instance for API calls
│ ├── App.jsx # Main app component
│ └── main.jsx # Entry point for React app
└── package.json # Project configuration and dependencies
Loom recording - https://www.loom.com/share/e7563e01ea334653aec65a8f1791bb3d
