Giter VIP home page Giter VIP logo

book-crud-app's Introduction

Book CRUD REST API

A basic CRUD REST api build with NodeJS

Tools Used

1. NodeJS
2. ExpressJS
3. JWT (authentication)
4. MondoDB(database)
5. Mongoose (ODM)
6. Bcrypt(hashing password)

Installation

Install my-project with npm

  git clone https://github.com/ameenshahh/Book-CRUD-App.git
  cd Book-CRUD-App
  npm install 
  npm run dev

Server starts on PORT 4000

Index route is localhost:4000

The list of available api end points will be listed i the index route.

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

PORT - Port number

DATABASE_URL - Mongodb connection url string

SECRET_KEY - secret for jwt token

API Reference

Sign up

  GET /signup

  Test Input :
  {
    "email":"[email protected]",
    "password":"test"
  }

Sign in

  POST /signIn

  Test Input :
  {
    "email":"[email protected]",
    "password":"test"
  }

Get all books

  GET /book/all

Add book

  POST /book/add
  test input : 
  {
    "title":"Othello",
    "summary":"A classic drama",
    "author":"William Shakespeare",
    "isbn":564942
  }

Get book by id

  GET /book/get/:bookId

Update book by id

  PUT /book/update/:bookId

Delete book by id

  DELETE /book/delete/:bookId

Production Url

  https://book-crud-rest-api.onrender.com/

Features

  • Sign Up
  • Sign In
  • List all books
  • Add book
  • Get book by id
  • Update book by id
  • Delete book by id

Authors

book-crud-app's People

Contributors

ameenshahh 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.