Giter Club home page Giter Club logo

rateit-rest-api's Introduction

RateIT REST API

REST API for the RateIT project - interactive platform for sharing cars and motorcycles reviews.

Installation

  1. After cloning the repository install dependencies with the command npm install / yarn install
  2. Create .env file in the main directory
  3. Create MongoDB cluster and database.
  4. Add your database address to the .env file as MONGO_URI=<yourDBaddress>
  5. Add SendInBlue API key to the .env file as SI_APIKEY=<yourSendInBlueAPIaddress>
  6. Add SendInBlue email address to the .env file as SI_EMAIL=<yourSendInBlueEmailAddress
  7. Add JWT secret key (it's up to your personal choice) to the .env file as JWT_SECRET=<yourJWTsecretKey>
  8. Type in npm start to run the server
  9. Additionally, you may use command npm test for testing issues, but you will also have to add additional values to the .env file

Routes

This API currently uses 3 main routes, for managing users, cars and motorbikes.

Documentation for the routes can be found here

rateit-rest-api's People

Contributors

kowalewskipawel avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

hocinemechouh

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.