Skip to content

mitrakmt/Notejs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notejs

The note taking app for developers.

API:

Getting Started:

All data can be accessed from the https://api.notejs.io. All data is sent and received as JSON.

Requests:

Users:

Request Endpoint Description Required data
POST /api/signup Post a user to the database. Required: name (String), password (String), password (String)
$.ajax({
  url: '/api/signup',
  data: {
    name: "Joe Bones",
    email: "exampleEmail@gmail.com",
    password: "password123"
  },
  success: function (response) {
    console.log("Successful signup!")
  },
  dataType: 'JSON'
});
Request Endpoint Description Required data
POST /api/login Login a user to the application Required: email (String), password (String)
POST /api/logout Post a user to the database. Required: None

Notes:

Request Endpoint Description Required data
POST /api/note Add note to user's list of notes Required: note (String)
GET /api/note/:noteId Get specific note data Required: None
DELETE /api/note/:noteId Delete note from user's note list Required: note (String)

Folders:

Request Endpoint Description Required data
GET /api/folder Get a list of all user's folders Required: None
GET /api/folder/:folderId Get one folder with all notes Required: Folder (String)

Errors:

Sometimes your API call will generate an error. Every response to an API call that generates an error will include an error code, the reason for the error, and an error message to help you debug your request.

Code Response Text Description
400 Bad Request
401 Unauthorized You do not have authorization to make the request.
403 Forbidden
404 Not Found The resource you tried to locate could not be found or does not exist.
500 Server Error An error occurred on our server.

Team:

Built With:

Front-End Back-End Modules Testing Frameworks
React Node JS Babel Mocha
Redux Express BodyParser Chai
Webpack SQL Morgan
Mongoose
Request
Bcrypt
Express-session

About

The premier note taking app for developers.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%