DEVELOPER STUDENT CLUBS TIET

officialWebsite

This is the repo for the official Website of DSC Thapar Institute of Engineering and Technology, Patiala , Punjab. Kindly go through the entire README.md for getting familiar with contribution steps

Installation and Setup

Setup and running of project (Backend)

Fork the repo and clone it.
Go in the repo and setup virtualenvironment using python -m virtualenv env
Then activate the environment using source env/Scripts/activate (Use only env/Scripts/activate if on cmd or powershell)
For Linux Users it will be source env/bin/activate
The project now uses poetry to manage dependencies.
Install Poetry
At the root of your project directory

poetry install
pre-commit install

This will setup the project requirements and pre-commit test hooks!
After the above setup, run

 - python manage.py makemigrations
 - python manage.py migrate

Start the backend server python manage.py runserver

This runs the backend server at default port 8000. Open http://localhost:8000 to view it in the browser.

Setup and running of project (Frontend)

At your root directory run yarn install to install all the dependencies
To start react dev server yarn start

This runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

Contribution to the project

We follow a systematic Git Workflow -

Create a fork of this repo.
Clone your fork of your repo on your pc.
Add Upstream to your clone
Every change that you do, it has to be on a branch. Commits on master would directly be closed.
Make sure that before you create a new branch for new changes,syncing with upstream is neccesary.

Commits

Write clear meaningful git commit messages (Do read this).
Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check this for more info)
When you make very very minor changes to a PR of yours (like for example fixing a failing Travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at here)
When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.

Note

As the project now uses poetry to manage dependencies, you need to run poetry add <package_name> to install the new package.
Use only yarn add package_name to add new packages to the frontend part.