Giter Club home page Giter Club logo

checkmate2020's Introduction

CHECKMATE-2020

Assigned Responsibilities

  • Mention the responsibilities assigned to you in the following format
  • Name : Responsibilities and Assigned Games

File structure

  • public [ Will contain frontend files ]
  • src
    • db
      • mongoose.js
    • graphql [ We won't be using graphql for this project initially, we can try shifting from REST to GraphQL later]
      • resolvers.js
      • schema.js
    • models
      • user.js
    • routers
      • main.js [ General endpoints ]
      • user.js [ User Management and auth]
    • app.js
    • index.js
    • passport.js
    • .gitignore

TODO

  • Add endpoints for Login and Registration in src/routers/auth.js

Requirements

npm install

Starting up the server

  • Start the mongo database using
cd {path-to-mongodb}/mongodb/bin
./mongod --dbpath {path-to-data-directory-for-mongo}/mongodb-data
  • Navigate to the root directory of the project in another terminal window.
  • To run the project in development mode, run npm run dev
  • To run the project in production mode, run npm run start
  • Go to localhost:3000 in your browser.

Note

  • Each of you shall be working in a separate router file under the folder src/routers
  • Depending on the requirements of the game, think whether you need a separate model for the game and accordingly add one under the folder src/models
  • Each of you shall work in a separate model
  • After you start making your router, make sure that you configure that router in src/app.js by adding app.use(router_name)
  • Code for various algorithms like participant matching should be kept in src/routers in a separate file
  • Environment variables can be set in config/dev.env
  • Whenever there is a change in package.json, you have to install new node_modules using :
npm install

Contributing [Important]

  • Make sure that you don't push code with bugs
  • Before making any commit pull the changes from the head repository
  • Don't make changes in portion assigned to other person without informing him
  • Make meaningful commits
  • Avoid using upload files, use the Command line for git
  • Avoid pushing unnecessary files like your IDE files. Make use of .gitignore . Currently vscode and webstorm ide files are only removed from git vcs.

checkmate2020's People

Contributors

pratham1002 avatar ashryaagr avatar aniketjain0317 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.