Giter Club home page Giter Club logo

poollooo / roadtrip-planner-api Goto Github PK

View Code? Open in Web Editor NEW
1.0 4.0 0.0 2.09 MB

We believe a life without journeys is one not lived at all. Our Roadtrip Planner REST API helps you get the most out of your vacations. Discover the most iconic restaurants & the most epic activities to do in every city in the world, so that you live your life to the fullest.

License: MIT License

JavaScript 100.00%
axios-rest express express-middleware jwt-authentication mongodb mongoose nodejs nodemailer npm

roadtrip-planner-api's Introduction

Roadtrip Planner Backend

Features

We believe a life without journeys is one not lived at all. Our roadtrip planner helps you get the most out of your vacations. Discover the most iconic restaurants & the most epic activities to do in every city in the world, so that you live your adventures to the fullest.

Model

  • User
  • City
  • Activity
  • SelectedActivities
  • Trip

Route

  • /user.routes
  • /trips.routes
  • /auth.routes
  • /activities.routes
  • /locationSearch.routes
  • /cities.routes

Features

  • Authentication
  • Email Verifications
  • Fetching External API
  • Planning

Configuration

Here is our API link (https://roadtrip-planner-ih.herokuapp.com/api). You can find more information about how to use it in the postman documentation below.

Postman documentation

To use our API, you can refer to our postman documentation ๐Ÿ“œ. https://documenter.getpostman.com/view/22850983/VUxPuScf

Getting Started

Make sure you have node installed.

$ node -v

v16.16.0

Server

To run the server in development, just type the command yarn dev or npm run dev.

Don't forget to install node_modules with yarn install or npm install.

Environment

  • PORT

This variable is more needed to development environment but heroku also ask fo this variable.

I set it to 3003 but you are free to put it at the value you want.

  • SECRET

Random token to use as a secret for JWT. To generate one, run node, then: crypto.randomBytes(64).toString('hex')

Development dependencies

This part is more for the developers on this project. You will find all the DevDependencies on the package.json.

roadtrip-planner-api's People

Contributors

poollooo avatar sebastienng avatar yuanliuddd avatar

Stargazers

 avatar

Watchers

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