Skip to content

Latest commit

 

History

History
executable file
·
119 lines (97 loc) · 2.52 KB

README.md

File metadata and controls

executable file
·
119 lines (97 loc) · 2.52 KB
Raw

ClassGrid

ClassGrid is a web application for students of IIT Delhi to create their timetables for the semester as per the courses they have taken. The application is built using ReactJS and Django Rest Framework. The application is hosted and can be accessed here.

Setup

In this section, we will guide you through the setup of the project on your local machine.

Prerequisites

  • Python 3.12.1 or higher
  • Node.js v18.19.1 or higher
  • npm v9.2.0 or higher
  • PostgreSQL 15 or higher

Procedure

  1. Create a fork of the main branch of this repository to your GitHub account and clone it to your local machine.

  2. Navigate to the project directory

cd ClassGrid
  1. Create a virtual environment and activate it
python3 -m venv env
source env/bin/activate
  1. Install the dependencies for the client
cd client
npm install
  1. Install the dependencies for the server
cd ../server
pip install -r requirements.txt
  1. Create a PostgreSQL database and user
sudo -u postgres psql
CREATE DATABASE db_name;
CREATE USER
    db_user
WITH PASSWORD
    'db_password';
ALTER ROLE
    db_user
SET client_encoding TO 'utf8';
ALTER ROLE
    db_user
SET default_transaction_isolation TO 'read committed';
ALTER ROLE
    db_user
SET timezone TO 'UTC';
GRANT ALL PRIVILEGES ON DATABASE
    db_name
TO
    db_user;
  1. Create a .env file in the server directory and add the following environment variables
SECRET_KEY=your_secret_key
DB_NAME=db_name
DB_USER=db_user
DB_PASSWORD=db_password
DB_HOST=db_host
DB_PORT=db_port
  1. Run the migrations
python manage.py migrate
  1. Start the server
python manage.py runserver
  1. Start the client
cd ../client
npm start

Contributing

We welcome contributions to the project. To contribute, please follow the steps below:

  1. Create a fork of the main branch of this repository to your GitHub account.

  2. Clone the forked repository to your local machine.

  3. Create a new branch for your feature or bug fix.

git checkout -b feature/your-feature
  1. Make your changes and commit them.
git add .
git commit -m "Your commit message"
  1. Push the changes to your forked repository.
git push origin feature/your-feature

  1. Create a pull request to the main branch of this repository.

  2. Wait for the maintainers to review your pull request.

Copyright

© 2024 Copyright : ClassGrid by DevClub IIT Delhi. All rights reserved.