Skip to content

maddiereddy/cribtrakr-api

Repository files navigation

CribTrakr is an app that keeps track of your rental properties and their related expenses.This repo houses the app's API


Live Demo:

https://evening-oasis-38989.herokuapp.com/

Technologies used:

Back End

  • Node.js (server-side scripting)
  • Express (server framework and API end point routing)
  • MongoDB(mLab) (database)
  • Mongoose (data modeling and schema)
  • Mocha Chai (unit testing)
  • Travis CI (continuous integration and deployment)
  • Heroku (deployment)

Security

  • Passwords are encrypted with bcryptjs
  • Passport.js was used as authentication middleware

Responsive

  • The app is responsive and optimized for both desktop and mobile viewing and use

API Documentation :

API endpoints

  • API for registering new users and checking existing user logins:

    • '/api/users' - POST, GET
  • API for creating JWTs:

    • '/api/auth'
    • '/api/login' - POST
  • API for rental property data:

    • '/api/rentals'
    • '/' - GET, POST
    • '/:id' - GET, PUT, DELETE
  • API for expenses data:

    • '/api/expenses'
    • '/' - GET, POST
    • '/:id' - GET, PUT, DELETE

To run locally:

  1. Clone repo locally
  2. run npm install
  3. run mongod in a new terminal
  4. run nodemon server.js

About

Server for CribTrakr app

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published