A basic auth starter app for node. Utilises mongodb and has basic user management and registration baked in
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
api
documentation
.env.example
.gitignore
API_ENDPOINTS.md
CHANGELOG.md
README.md
package.json
server.js
yarn.lock

README.md

Node Starter App

This project is to serve as a simple node starter application with login, registration and user management routes. All requests will be authenticated with JWT tokens and have granular permissions.

Contents

Setup

clone the project and run

$ yarn install

Development

Currently there is only a simple development environment which is started by running:

$ npm run start

Build & Deployment

No build process yet setup

API Endpoints

As there will be quite a few endpoints we have split them down into their own files so they can easily moved to a hosted API documentation solution at a later stage. A current list of all endpoints can be found in API_ENDPOINTS.md

Contributing

No guidelines yet...

Changelog

As far as possible this projects changelog should be kept up to date for all releases to production. This should include bug fixing and feature releases. When a major version of the project is released a version branch will be made to keep a updatable version of historic code for bug fixes only. e.g. v1.x.x when moving to v2.0.0. The full changelog can be found in the CHANGELOG.md

License

This project is licensed under the MIT license, however all data in any examples is reserved as copyright of the original creator.

Credits

None so far :-)