/wenova-am-extranet-api

Primary LanguageJavaScript


Wenova-AM Extranet API

GitHub package.json version

API for Wenova-AM's extranet app.

Docker koa JWT NodeJS Jest Yarn ESLint

⚡️ Quickstart

  • Clone the repository
git clone https://github.com/occupytheweb/wenova-am-extranet-api

Docker

Pre-Requisites

Building

docker compose build

This will download and cache dependencies, and build the initial development image.

🚀 Running in development mode

docker compose up

Node + Yarn

yarn
  • Launch the development server
yarn dev

Configuring the runtime

Prior to an initial launch, run:

yarn generate-jwt-signing-key

This will generate a base-64 encoded JWT signing key, and print out the instruction of what to add to the app's environment:

JWT signing key generation

The API supports the following configuration keys:

ENCODED_JWT_SIGNING_KEY : (required)     : Random key, used to sign JWTs. Changing this invalidates previously issued JWTs.
MAX_ITEMS_PER_PAGE      : (default=50)   : The fallback page size for paginated data, when the limit is not specified in a query.
PORT                    : (default=4000) : The port on which the API listens for connections.

DB_USER      : (required)          : The username to use for connecting to the DB.
DB_PASSWORD  : (default="")        : The password to use for connecting the the DB.
DB_NAME      : (required)          : The name of the database to connect to.
DB_HOST      : (default=localhost) : The hostname of the database to connect to.
DB_PORT      : (default=3306)      : The port on which to establish the DB connection.
DB_POOL_SIZE : (default=10)        : The maximum size of the connection pool.

These can either be added to the environment prior to launch, or be configured in a .env file at the root of the API's directory.

Testing

Testing is done with Jest and Docker.

More info soon.

🚀 Deployment

Docker

Native, with PM2

  • Create a deployment user and group
sudo useradd extranet-stack --base-dir /opt
  • Add allowed users to the deployment group
usermod -a -G extranet-stack some-user
  • Prepare the base directory for the stack
cd /opt
sudo mkdir .pm2
sudo chown extranet-stack:extranet-stack .pm2
sudo chmod g+ws .pm2
git config --global --add safe.directory "*"
  • Prepare PM2's environment
printf "\nexport PM2_HOME=/opt/.pm2\n\n" | sudo tee -a /etc/{profile,zprofile}

This adds PM2_HOME=/opt/.pm2 to the files /etc/profile and /etc/zprofile, which effectively sets the PM2_HOME environment variable to the same value for all users.

yarn global add pm2
  • Clone the API
cd /opt/extranet-stack
git clone https://github.com/occupytheweb/wenova-am-extranet-api extranet-api
chown extranet-stack:extranet-stack -R .
yarn
  • Start the API
pm2 start src/app.js --name extranet-api
pm2 save
sudo chown extranet-stack:extranet-stack -R /opt/.pm2
pm2 startup

Paste the printed command, but modify the -u parameter to -u extranet-stack, and the --hp parameter to --hp /opt.

For instance:

sudo env PATH=$PATH:/usr/bin /usr/lib/node_modules/pm2/bin/pm2 startup systemd -u extranet-stack --hp /opt

This will generate and enable a Unix daemon service which will handle starting pm2 upon server boot.

Updating the API

cd /opt/extranet-stack/extranet-api
git pull
yarn
pm2 reload extranet-api

Hits