Code Monkey home page Code Monkey logo

rest-api-node's Introduction

NodeJS logo

Node API

Description

Node API is production ready and open source project in Node, Express and MongoDB

Documentation

Swagger Docs https://rest-api-node.herokuapp.com/docs/

Support

This application is hosted on Heroku and serve a bunch of AJAX requests to give and manipulate data from database and give a support to test front end applications

Servers

Server Description Api Url Branch (GitHub)
staging Open Api https://rest-api-node.herokuapp.com master
production Authenticated Api https://rest-api-node-production.herokuapp.com production

Showcase

Application Code (GitHub) Server
https://typescript-angular4.herokuapp.com/ https://github.com/renanlopescoder/typescript-angular4 staging
http://mobx-react.herokuapp.com/ https://github.com/renanlopescoder/mobx-react staging
http://vue-clash.herokuapp.com/ https://github.com/renanlopescoder/vue staging

Routes

Projects

URL Collection Method Parameters Response Action
https://rest-api-node.herokuapp.com/projects projects get Nothing JSON with Array Get a list of projects in the database
https://rest-api-node.herokuapp.com/projects/create projects post JSON JSON Add JSON into the database
https://rest-api-node.herokuapp.com/projects/update/:id projects put id, JSON Update the document with sent JSON data
https://rest-api-node.herokuapp.com/projects/select/:id projects get id JSON Return the document, related to the sent id
https://rest-api-node.herokuapp.com/projects/delete/:id projects delete id status 200 Delete the document, related to the sent id

Users

URL Collection Method Parameters Response Action
https://rest-api-node.herokuapp.com/users users get Nothing JSON with Array Get a list of users in the database
https://rest-api-node.herokuapp.com/users/create users post JSON JSON Add JSON into the database
https://rest-api-node.herokuapp.com/users/update/:id users put id JSON Update the document with sent JSON data
https://rest-api-node.herokuapp.com/users/select/:id users get id JSON Return the document, related to the sent id
https://rest-api-node.herokuapp.com/users/delete/:id users delete id status 200 Delete the document, related to the sent id

Collections

Schema Project (projects)

Name Description Type
project project name String
technologies project technologies String
description project description String
demoLink demo link String
githubLink GitHub link String
author author's name String
authorLink links to author (website, linkedin) String
project project name String
status project status (Development / Production) String

Schema User (users)

Name Description Type
username user name String
password user password (hash) String
email user mail String
photo user photo String
nickname user nickname String

API

Technology Description Link
Heroku Cloud Platform [heroku.com]
Heroku mLab Dyno MongoDB database server [mlab.com]
GitHub Version Controlling [github.com]

API Directories

  • Routes ./src/routes
  • Models ./src/app/Models
  • Controllers ./src/app/Controllers
  • Services ./src/app/Services
  • Config consign and express ./src/config/express.js
  • Server configuration and application startup ./server.js

Configuring the API locally

  • Download or clone the project access the project folder with the terminal and execute the CLI npm install
  • To change database change on constants the databaseUrl
  • Run the server npm start
  • Access in your browser http://localhost:3000/projects

API Dependencies

rest-api-node's People

Contributors

ericanderson29 avatar

Watchers

 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.