Giter Club home page Giter Club logo

expressjs-simple-note-app-restful-api's Introduction

ExpressJS - Simple Note App RESTful API

restfulapi

Table of contents

Introduction

Express.js Node.js

Here i was built the Simple Note App which specially for backend only.

Express.js, or simply Express, is a web application framework for Node.js. More about Express

Requirements

  1. node_modules
  2. Postman
  3. Web Server (ex. localhost)

How to run the app ?

  1. Open CMD or Terminal and enter to the app directory
  2. Type npm install
  3. Make a new file called .env in the root directory, set up first here
  4. Turn on Web Server and MySQL can using Third-party tool like xampp, etc.
  5. Import file simple_note_app.sql to phpmyadmin
  6. Open Postman desktop application or Chrome web app extension that has installed before
  7. Choose HTTP Method and enter request url.(ex. localhost:3000/notes)
  8. You can see all the end point here

Set up .env file

Open .env file on your favorite code editor, and copy paste this code below :

NODE_ENV=development
PORT= // fill with your port

DB_HOST=localhost
DB_USER=root // default
DB_PASS= // default
DB_NAME=simple_note_app

End Point List

1. GET

  • /notes
  • /notes/:id (Get notes by id)
  • /category
  • /category/:id (Get category by id)
  • /notes/category/:id (Get notes by category id)
  • /all-notes (Get all notes with category name)
  • /notes?search=note_title (Search operation)
  • /notes?sort= (Sort operation) // fill with asc or desc
  • /notes?page= (Paging for limiting notes) // fill only with integer

2. POST

  • /notes
  • /category

3. PATCH

  • /notes/:id (Update notes by id)
  • /category/:id (Update category by id)

4. DELETE

  • /notes/:id (Delete notes by id)
  • /category/:id (Delete category by id)

Author

Author Andre Feri

Andre Feri Saputra

expressjs-simple-note-app-restful-api's People

Contributors

andreferi3 avatar

Stargazers

 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.