DEVELOPER STUDENT CLUBS TIET

This is the repo for the **Algo Book** by Developer Student Clubs, TIET, Patiala , Punjab. Kindly go through the entire README.md for getting familiar with contribution steps

ALGO-BOOK

To Start

1. Clone the repository
2. npm i or yarn install
3. npm start

Scripts

Dev frontend server (no SSR or api server)

npm run dev (all axios requests are proxied to 'http:localhost:${process.env.SERVER_HOST}/api')(configured in webpack.development.js)
Dev backend server (only api server)

npm run dev:server (make sure there is a .env.dev file with server=true and SERVER_PORT set)
Prod build

npm run prod
Run linter

npm run lint
Run prettier

npm run format
Start Server and Use SSR

npm start

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.

All feedback and suggestions are welcome!

💬 Join the community on Discord