powerhouse-inc / switchboard-boilerplate

Open-source API over the document model made to be developer- and analyst-friendly

Powerhouse Switchboard

Open-source API over the document model made to be developer- and analyst-friendly.

Project structure

• /api directory contains the core logic that creates the API over the database
• /frontend directory contains the frontend-related code

Quick start

Using docker (recommended)

1. Set up required environment variables for the API
   • Default values can be copied via cp ./api/developer.env ./api/.env
2. Start the project via a single docker-compose command

   docker-compose up --build --force-recreate

3. Open http://localhost to view the frontend

Using plain Node.js (for the development)

In order to develop the project further, please navigate to the /api and then to the /frontend directories to follow concrete instructions how to start those services separately on two different ports.

Project requirements

To understand what is planned you can read and ask questions here:

• Initial Requirements: #3
• Document Model explanation: #1

Coding Setup

To install correct node version, we recommend that you use nvm. If you have nvm installed you can run nvm install && nvm use to automatically use the correct node version. The version is detected from the .nvmrc.

If you do not have a code editor setup, we recommend that you use Visual Studio Code to get started. It is very beginner friendly and you can move on to something else down the road if you want to.

Health endpoints

Both api and frontend have health endpoints that can be used to check if the service is up and running.

See the respective descriptions in the api and frontend READMEs.