Git Product home page Git Product logo

nishamehra / algo-book Goto Github PK

View Code? Open in Web Editor NEW

This project forked from developer-student-club-thapar/algo-book

0.0 0.0 0.0 2.52 MB

The algo book that contains various algorithms in 4 different languages

Home Page: https://algo-book.dsctiet.tech

License: GNU General Public License v3.0

Shell 0.10% JavaScript 31.99% CSS 0.68% HTML 0.24% Dockerfile 0.42% C++ 27.89% Java 19.38% Python 14.12% Nim 5.18%

algo-book's Introduction

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
  1. 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)

  2. 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)

  3. Prod build

    npm run prod

  4. Run linter

    npm run lint

  5. Run prettier

    npm run format

  6. 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

algo-book's People

Contributors

specter25 avatar jsparmani avatar aryaman1706 avatar nishamehra avatar rishabhjain-28 avatar dakshkk avatar imgbotapp avatar pranavvidyarthi7 avatar mr-robot183 avatar renu-code avatar rishikr3101 avatar akgupta-47 avatar shivom2k avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.