Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

68 lines (43 loc) · 1.44 KB
Raw

If you would like to contribute to the project, please follow these guidelines:

  1. Fork the original WnCC repository to your personal account.

  2. Clone the forked repository locally.

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

  4. Make the necessary changes and commit them.

  5. Push your changes to your forked repository.

  6. Submit a pull request to the main repository with your branch, explaining the changes you made and any additional information that might be helpful for review.

Usage

Clone the Git repository:

  # Clone your fork of the GitHub Repo
  git clone https://github.com/your_username/SoC-Portal.git

Install JS packages

  cd frontend
  npm install

Create Virtual Environment:

  cd backend
  python3 -m venv venv
  ./venv/Scripts/Activate.ps1 # Windows
  source ./venv/bin/activate # Linux/MacOS
  pip3 install -r requirements.txt

Run Application

  # Frontend (in ./frontend/)
  npm run start
  # Backend (in ./backend/)
  python manage.py runserver

Resources

Backend

Django - https://docs.djangoproject.com/en/4.2/

Django-Rest Framework - https://www.django-rest-framework.org/

Simple JWT - https://django-rest-framework-simplejwt.readthedocs.io/en/latest/

Frontend

React Framework - https://legacy.reactjs.org/docs/getting-started.html

JavaScript - https://javascript.info/

React Router - https://reactrouter.com/en/main

Axios - https://github.com/axios/axios