⚠️ This repository is not maintained anymore. The current version of the kulturdaten API can be found here
API application based on Adonis.js to power the kulturdaten.berlin frontend.
To develop the application make sure your machine meets the following requirements:
- Node.js 15.12.0 (for example via nvm)
Before you can start developing you need to install all needed dependencies:
npm installBefore starting the development server, make sure to configure your environment. You can use the following as a starting point. Simply copy this into a .env file in the project root:
PORT=3333
HOST=0.0.0.0
NODE_ENV=development
APP_KEY=CU2cKM6eSbndUQUI74veu3KG4V1gpT7S
DB_CONNECTION=sqlite
You can use node ace generate:key to create a personal APP_KEY which is used to hash cookies.
Afterwards start the development server, including file watching and recompilation of TypeScript with:
npm run develop
The development server is then accessible at http://localhost:3333.
To setup the API on a fresh dokku instance run the following commands, using the kulturdaten-berlin.anyvent.cloud as a demo host:
At first make sure your instance (assuming Ubuntu) is up to date:
sudo apt-get update
sudo apt-get upgrade
sudo apt-get install dokku-update
dokku-update
Afterwards install all needed plugins. The API is driven by an PostgreSQL database for production, we'll be using LetsEncrypt for easy SSL-protection.
dokku plugin:install https://github.com/dokku/dokku-postgres.git postgres
dokku plugin:install https://github.com/dokku/dokku-letsencrypt.git
You may also want to disable redirecting all traffic with an unknown HOST header to the lexicographically first site in the nginx config as documented by deploying 000-noop for example.
Next create the app and setup suiting environment variables. We are going to setup two environments: live and beta. Alongside with the application we are also going to create two database instances.
dokku apps:create beta.api.kulturdaten.berlin
dokku postgres:create pg-beta-api-kulturdaten-berlin
dokku postgres:link pg-beta-api-kulturdaten-berlin beta.api.kulturdaten.berlin
dokku apps:create api.kulturdaten.berlin
dokku postgres:create pg-api-kulturdaten-berlin
dokku postgres:link pg-api-kulturdaten-berlin api.kulturdaten.berlin
Then you will need to configure the apps specific to the environment they should resemble:
dokku config:set --no-restart beta.api.kulturdaten.berlin PORT=5000 HOST=0.0.0.0 NODE_ENV=beta DB_CONNECTION=pg
dokku config:set --no-restart api.kulturdaten.berlin PORT=5000 HOST=0.0.0.0 NODE_ENV=live DB_CONNECTION=pg
You'll also need to set secret keys using the node ace generate:key command together with:
dokku config:set --no-restart beta.api.kulturdaten.berlin APP_KEY=${key}
dokku config:set --no-restart api.kulturdaten.berlin APP_KEY=${key}
To be able to persist uploaded images you need to mount a directory outside of the container:
mkdir -p /var/lib/dokku/data/storage/beta.api.kulturdaten.berlin/media
chown -R dokku:dokku /var/lib/dokku/data/storage/beta.api.kulturdaten.berlin/media
chmod -R a+w /var/lib/dokku/data/storage/beta.api.kulturdaten.berlin/media
dokku storage:mount beta.api.kulturdaten.berlin /var/lib/dokku/data/storage/beta.api.kulturdaten.berlin/media:/build/public/media
To setup automated deploys via GitHub actions, issue a dedicated SSH key for GitHub to authenticate by running
mkdir ./keys
ssh-keygen -t rsa -C [email protected] -f ./.keys/id_rsa
cat ./.keys/id_rsa.pub | ssh [email protected] dokku ssh-keys:add [email protected]
dokku postgres:unlink pg-alpha-api-kulturdaten-berlin alpha.api.kulturdaten.berlin
dokku postgres:destroy pg-alpha-api-kulturdaten-berlin
dokku postgres:create pg-alpha-api-kulturdaten-berlin
dokku postgres:link pg-alpha-api-kulturdaten-berlin alpha.api.kulturdaten.berlin
Thanks goes to these wonderful people (emoji key):
 Mathies Schneider 💻 📖 |
 Boris Fruendt 💻 📖 |
 Matthias Rohmer 💻 📖 |
 Fabian Morón Zirfas 🚧 |
 Lucas Vogel 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome!
A project by:
|
Supported by:
|