node-rest-auth-arangodb

An API with JWT user authentication. Project works out of the box with Docker, or just localhost. Be sure to follow the setup instructions so that env vars are passed in.

Made using:

• Nodejs
• Express
• jwt-simple
• Passport
• ArangoDB

Only tested with macOS

Requirements

• Docker

Optional Requirements

• Node.js version 9+

Setup

• Update HOSTNAME=your hostname goes here in file .env-example
• Rename .env-example to .env
• Rename env/your hostname here to match your hostname exactly

You can get the hostname of your machine by running hostname in the command terminal.

To Run

• docker-compose up -d (or just docker-compose up)

When done, docker-compose stop or docker-compose down. I notice the API image has to be erased manually to get the code to update, use docker image remove <image ID>.

To Run On localhost

If you'd rather run node on localhost, then...

• yarn install
  • (Yarn is faster than npm, if you don't have it, do npm install -g yarn)
• Rename env/your hostname here to match your hostname exactly
  • (If you don't know your hostname, run hostname in the terminal)
• Change the ARANGODB_DOCKER_NAME ENV var to localhost instead of database
• docker-compose up -d database to run ArangoDB (or just docker-compose up database)
• npm start to run the API on localhost, or npm run start:watch for auto-reload

If you're going to run ArangoDB on localhost, see scripts/boostrap.js, this runs automatically when using docker-compose.

When Done

docker-compose down will clean up for you.

docker-compose build api (or just docker-compose build) will build the API image (so you can deploy to Kubernetes or whatnot).

RESTful API endpoints

Postman is a great tool for using the API. Otherwise, see the sample cURL command below.

POST /api/users/register

Register by providing username and password.

curl -X POST http://localhost:9191/api/users/register -d 'username=jim&password=password'

POST /api/users/authenticate

Authenticate by providing username and password.

curl -X POST http://localhost:9191/api/users/authenticate -d 'username=jim&password=password'

GET /api/users/memberinfo

Get user data by providing token.

curl -X GET http://localhost:9191/api/users/memberinfo -H 'Authorization: JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6ImppbSIsImV4cGlyYXRpb24iOjE1MzIyNzMxMjQwODV9.uKTvxRwZbRMF_WYA5EmVKGvGUJc3Wx9TTjWR7I7MLy4'

Credits

Based on https://github.com/clemudensi/nodeJS_backend

License

MIT