Code Monkey home page Code Monkey logo

mafia-api's Introduction

Api starter app

This app is meant to be used as a starting point for creating backend APIs. The app is a simple express app with built in token authentication for users.

Running

  1. Clone the repository.
  2. Run npm install.
  3. If running in a dev environment, set up the mongo db.
    1. Create the following directory paths in your home folder:
      • ~/mongodb/<api-name>/data/db
      • ~/mongodb/<api-name>/logs
    2. Update the mongo conf file in /models/mongod.conf. The path and dbpath variables should point to paths you just created.
  4. In a new terminal window run npm run mongo to start the mongdb database.
    1. In order to later stop the mongo database run npm run mongo-stop.
  5. In the same window run npm run start to start the api.

Routes

Login

POST /auth/login
body
    {
      email,
      password
    }
Returns
    {
      token: (token)
    }

Create user

POST /users
body:
    {
      email,
      password
    }
Returns
    {
      token: (token)
    }

Get user

GET /users
body:
    token (can also be in the header as 'x-access-token')
Returns
    user object

Update user

PUT /users
body:
    token (can also be in the header as 'x-access-token'),
    The body should contain the updated user object
Returns
    nothing

Delete user

DELETE /users
body:
    token (can also be in the header as 'x-access-token')
Returns
    nothing

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.