Code Monkey home page Code Monkey logo

notes-api-backend's Introduction

notes-api-backend

Notes API Backend - This API will be consumed by Android App present at https://github.com/APushpendra08/notes-app-android-mvvm.git

NOTE : Deployed on https://notes-app-ipa.herokuapp.com/

Setup the app to run

  1. Clone the repository
  2. Install node modules - npm install
  3. Create .env files in root of project and add these two parameters - SECRET_KEY and MONGO_URL.

    MONGO_URL will be connection string for MongoDB to store the data
    SECRET_KEY will be used for Authentication purpose.

  4. Start the Node.js Application - npm start
  5. Test the Server - Goto root of the host URL and see if the connection was established and a response was recieved -
    Welcome to NotesAPI Backend

Endpoints

Login Endpoints

Method URL Description Required Parameters
GET /users/signup Sign-up to NotesApp username
password
email
POST /users/signin Sign-in to NotesApp username
password
email

Notes Endpoints

Method URL Description Required Parameters
GET /note/ Get all Notes for the user N/A
POST /note/ Add a new note for the user title
description
DELETE /note/:id Delete a note for given id id as param
PUT /note/:id Update the note for the given id id as param
title
description

notes-api-backend's People

Contributors

apushpendra08 avatar

Watchers

James Cloos avatar avatar

Forkers

alpharoman

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.