Giter Club home page Giter Club logo

noteful-json-server's Introduction

Noteful JSON Server

This is a project for education purposes created by Thinkful.

This is a json-server managed API meant for developing noteful-client projects.

Once started, this will run a local API server on http://localhost:9090.

If you navigate to the base URL there will be a HTML documentation page displayed.

There are two top level endpoints:

  • /folders
  • /notes

Both support GET, POST, PUT, PATCH and DELETE requests. For PUT, PATCH and DELETE requests you must supply the respective id in the endpoint's path.

For example:

  • GET /notes
  • GET /folders
  • POST /notes
  • POST /folders
  • PATCH /notes/{note-id}/
  • PATCH /folders/{folder-id}/
  • DELETE /notes/{note-id}/
  • DELETE /folders/{folder-id}/

To start the server, run npm start.

The database is initiated from the db.js file whenever the server is started. No data is persisted after the server has been shut down.

noteful-json-server's People

Contributors

tomatau avatar

Stargazers

 avatar  avatar  avatar

Watchers

 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.