This is a basic user authentication boilerplate made with NodeJS using Express and MongoDB. This application allows you to make a POST request to either a sign-in or signup endpoint allowing you to register, and re-authenticate. Both endpoints return a JSON Web Token (JWT) which can be used in a Front-End application.
This application can be installed via npm by running npm install. You'll need to also install MongoDB for the database which will store your users. With both installed run mongod first, followed by node index.js to start the server on port 3090.
If you get a permissions error related to the /data/db directory it may be necessary to run the command listed here.
For security purposes you'll also need to adjust the secret value found within config.js. Leaving it as its default value is highly unrecommended.
There's two POST endpoints that are provided and one GET endpoint.
The /signup endpoint expects a JSON object containing both an email address and password, once recieved it encrypts and stores the information in the database and returns a token. If you attempt to signup with an email that already exists in the database the server will reject it and return an error.
The /signin endpoint also expects a JSON object containing both an email address and password, once recieved it checks if the user exists and if the provided password matches that of the one in the database. If it doesn't the server will reject the signin request and return an unauthorized error. If it does match the server will return a token.
Below is an example of the type of JSON object the endpoints expect.
{
"email": "example@example.com",
"password": "1323"
}
If authenticated you're able make a GET request to /private to get a piece of data returned from the server. You can modify the returned data within router.js.
Within the client directory of this repository is a simple React application that makes use of this boilerplate and its endpoints. To install it please visit the provided readme file.