RJHsiao / api-exercise-nodejs

A side project to build a simple login API for practicing Node.js

API Exercise - Node.js

A simple, prototyping account management API service developing with Node.js, that can:

1. Register a new account.
2. Login/logout.
3. Show/edit account info.

Runtime Environment

• Node Js v10.x+
• MongoDB v3.6+

How To Use

1. Clone this project to local.
2. Run command npm install under the project's folder at the first time.
3. Run command npm start to start service.

Options: Environment Variable

• PORT: the number of HTTP port for listening. Default: 3000
• DB_URL: the connection URL to connect the MongoDB for data storage. Default: mongodb://localhost/api-exercise

Testing, Documentation

Documentation & Testing UI generated by swagger. URL: http://<hostname_or_ip>:<port>/api-doc/v1/
Default URL: http://localhost:3000/api-doc/v1/