smartbirds-server

How to help

You can help translate the project.

Dev setup

Initialize the containers

npm install
npm run build
docker-compose up
docker-compose run web npm run seed

From this point on only start in enough

docker-compose start

Encryption

To generate a new encryption key for API response encryption:

# Using Node.js
node -e "console.log(require('crypto').randomBytes(32).toString('base64'))"

# Using OpenSSL
openssl rand -base64 32

Set the generated key as an environment variable:

export API_ENCRYPTION_KEY="your-generated-key-here"

The key must be 32 bytes and can be provided in base64 or hex format. Optionally set API_ENCRYPTION_KID for key identification (defaults to '1').

Structure

The project contains both frontend angular 1.5 application and backend actionhero.js application.

Frontend

Code is in client/scripts split by types. To build in dev use npm run budo - this will run a live-update server.

Backend

Code is in server. To run server in dev use npm run ah - to use the docker db use docker-compose start db dbadmin

License

AGPL-v3.0

Copyright (c) 2015-2018 Bulgarian Society for the Protection of Birds