Skip to content

Latest commit

History

14 Commits

Folders and files

NameName
Last commit message
Last commit date

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:

RequestEndpointDescriptionRequired data
POST/api/signupPost 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'});
RequestEndpointDescriptionRequired data
POST/api/loginLogin a user to the applicationRequired: email (String), password (String)
POST/api/logoutPost a user to the database.Required: None

Notes:

RequestEndpointDescriptionRequired data
POST/api/noteAdd note to user's list of notesRequired: note (String)
GET/api/note/:noteIdGet specific note dataRequired: None
DELETE/api/note/:noteIdDelete note from user's note listRequired: note (String)

Folders:

RequestEndpointDescriptionRequired data
GET/api/folderGet a list of all user's foldersRequired: None
GET/api/folder/:folderIdGet one folder with all notesRequired: 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.

CodeResponse TextDescription
400Bad Request
401UnauthorizedYou do not have authorization to make the request.
403Forbidden
404Not FoundThe resource you tried to locate could not be found or does not exist.
500Server ErrorAn error occurred on our server.

Team:

Built With:

Front-EndBack-EndModulesTesting Frameworks
ReactNode JSBabelMocha
ReduxExpressBodyParserChai
WebpackSQLMorgan
Mongoose
Request
Bcrypt
Express-session

About

The premier note taking app for developers.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages