codehub-website

Folder	Purpose
/frontend	React project goes here (static pages, UI components, etc.)
/backend	Django project files go here (models, views, serializers, etc.)
/design	Figma exports, wireframes, mockups (PNG, PDF, or embedded links)
/docs	Project documentation (meeting notes, setup guides, database schema)

How to run Django's server locally:

1. Create a virtual environment in the main directory:

$ python -m venv .venv
$ source .venv/bin/activate # On Windows use: venv\Scripts\activate

2. Install packages:

$ pip install -r backend/requirements.txt

3. Test if the database server is running:

Note

The previous database setup has been taken down. Everyone will have to set up a local database.

$ python backend/manage.py dbshell

This should directly open the database and allow you to interact with it.

Warning

A superuser has all permissions by default, so caution is advised.

4. Create a superuser (only for leads):

$ python backend/manage.py createsuperuser

It will prompt you for the required information.

5. Run the server:

$ python backend/manage.py runserver

Now the server should be available at http://localhost:8000/. If you are a superuser, you can access the admin panel with http://localhost:8000/admin. The API is available at http://localhost:8000/api/.

API Reference:

The API reference can be accessed at the api/schema endpoint when the server is running. Accessing the endpoint will allow you to download a yml file. Accessing api/schema/swagger-ui will direct you to the API docs page.

To run Frontend

1. Installation:

npm i

2. Run Development Server

npm run dev