RIDDLER BACKEND 2021

Backend of Riddler-2021
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• Table of Contents
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contributors

Built With

• Node.js
• Express.js
• MongoDB
• Docker

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/csivitu/riddler-backend-2021.git

2. Install NPM packages

npm install

3. Add .env file

DB_CONNECTION= <MONGO_URL>
JWT_SECRET=<JWT_SECRET>
JWT_EXPIRY=<JWT_EXPIRY>

4. For docker-compose

docker-compose build up --d

Usage

This will start a development server that will restart the app when a file change is detected

nodemon app.js

For production:

npm start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push -u origin feature/AmazingFeature)
5. Open a Pull Request

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project 😄.

License

Distributed under the MIT License. See LICENSE for more information.

Contributors

Thanks goes to these wonderful people:

Vidhi Khaitan 💻 📖

Sourish Gupta 💻 📖

Nimish Jain 💻 📖

Shivansh Sharma 💻 📖