Node.js web backend. Project setup has been generated using express-generator.
- Node.js 8.9+
- MongoDB
- For backend tasks development:
npm install
npm start
Open http://localhost:3002 in your browser.
npm test
Console output includes also coverage report.
npm run lint
npm run cibuild
# List all user commands
node src/apps/user/commands.js --help
# List users
node src/apps/user/commands.js getUsers
# List account profiles
node src/apps/user/commands.js getAccountProfiles
It is envisioned that project remains more or less as pure backend. There is currently only one template in use that bootstraps Angular client. The client code is from https://github.com/jojanper/angular-app.
Get the code:
npm run client-install
This monitors any changes in client code and builds it whenever needed. Also starts the backend server and creates new root template for every client code change. The backend server is also restarted on every backend code change. Creates debug builds for frontend.
npm run fullstack-dev
Same as above but creates release builds for frontend.
npm run fullstack-prod
The Node.js app uses node-celery to queue tasks from Node.js to Celery. The application acts therefore as Producer whereas Celery is the Consumer. Mixed language development is needed since Celery operates in Python domain. Communication between Producer and Consumer requires message broker (RabbitMQ in this case). After prerequisites for backend tasks development have been installed, the installation is finalized with
sudo apt-get install python3-pip (optional)
sudo pip3 install virtualenv (optional)
npm run virtualenv-install
source virtualenv/draal/bin/activate
This will install python dependencies as virtualenv under current folder.
npm run pytests
npm run pylint
export CELERY_ON=1
celery -A pytasks.celery_app:app worker -l info
The RabbitMQ broker need to be running, to see RabbitMQ status
sudo service rabbitmq-server status
To start the application as Producer
CELERY_ON=1 npm start
GraphQL API endpoint is available in /api/graphql.
To query users:
curl -X POST -H "Content-Type: application/json" --data '{"query": "{users{id,email}}"}' http://localhost:3000/api/graphql
To query a user:
curl -X POST -H "Content-Type: application/json" --data '{"query": "{user(id: \"<user-id>\"){id,email}}"}' http://localhost:3000/api/graphql
Quick examples using curl.
User login:
curl POST -H "Content-Type: application/json" -v --data '{"email": "<email>", "password": "<password>"}' http://localhost:3000/api/auth/v1/login
Get API token:
curl POST -H "Content-Type: application/json" -v --data '{"email": "<email>", "password": "<password>"}' http://localhost:3000/api/auth/v1/token
Use API token in HTTP request:
curl POST -H "Content-Type: application/json" -H "Authorization: Bearer <api-token>" -v --data '' http://localhost:3000/api/auth/logout
https://travis-ci.org/jojanper/draal-jsapp
- Install Docker
- Linux users should install also Docker compose
Docker Compose is used to run multi-container Docker applications. This project currently creates multiple containers: the actual nodejs application, background task worker(s) for the application, NGINX reverse proxy, RabbitMQ message broker and MongoDB database. The application is accessible at http://localhost:8088.
To build the project (for development mode, docker-compose.override.yml overrides default values)
npm run docker-build
To build production version of the project (uses distroless nodejs Docker image)
npm run docker-build-prod
To start the application
npm run docker-run
To start the application in detached mode
npm run docker-rund
To stop application container
npm run docker-stop
npm run docker-rm # (to remove the application container)
To debug container
docker exec -t -i <container-id> /bin/bash
Usefull Docker commands
# Stop and remove containers
docker stop $(docker ps -a -q)
docker rm $(docker ps -a -q)
# Remove images
docker rmi $(docker images -q)
docker system prune
Example application deployment setup is outlined here. The deployment uses AWS Fargate within Elastic Container Service. Currently only NGINX reverse proxy and actual application server are in use (no backend tasks processing available at the moment).
If you get following error:
[nodemon] Internal watch failed: watch <file-path> ENOSPC
try increasing the limit per user for the max number of watches:
echo fs.inotify.max_user_watches=582222 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p