Izaac 2.1 Project
This project consists of a Django backend and a React/TypeScript frontend. Below are instructions for setting up and running both parts in development mode.
Prerequisites
- Python 3.x
- Node.js (LTS version recommended)
- npm or yarn
- SQLite (included with Python)
Backend Setup
- Navigate to the backend directory:
cd backend
- Create and activate a virtual environment:
python -m venv venv
source venv/bin/activate # On Windows use: venv\Scripts\activate
- Install dependencies:
pip install -r requirements.txt
- Run database migrations:
python manage.py migrate
- Start the development server:
python manage.py runserver
The backend will be available at http://localhost:8000
Frontend Setup
- Navigate to the frontend directory:
cd frontend
- Install dependencies:
npm install
# or if you use yarn:
yarn install
- Start the development server:
npm run dev
# or if you use yarn:
yarn dev
The frontend will be available at http://localhost:5173
Development
- Backend API documentation is available at
http://localhost:8000/api/docs/when the server is running - Frontend hot-reloading is enabled by default
- Backend hot-reloading is enabled by default with Django's development server
Project Structure
/backend- Django backend application/frontend- React/TypeScript frontend application/nginx- Nginx configuration files
Additional Notes
- Make sure both backend and frontend servers are running simultaneously for full functionality
- The backend uses SQLite as the database by default
- Frontend is built with Vite and uses Tailwind CSS for styling
Description
Languages
TypeScript
71.6%
Python
26.1%
JavaScript
1.6%
CSS
0.4%
HTML
0.2%