Contributing

You can greatly support Plunk by contributing to this repository.

Support can be asked in the #contributions channel of the Plunk Discord server

1. Requirements

Docker needs to be installed on your system.

2. Install dependencies

Run yarn install to install the dependencies.

3. Set your environment variables

Copy the .env.example files in the api, dashboard and prisma folder to .env in their respective folders.
Set AWS credentials in the api .env file.

4. Start resources

Run yarn services:up to start a local database and a local redis server.
Run yarn migrate to apply the migrations to the database.
Run yarn build:shared to build the shared package.
Run yarn dev:api to start the API server.
Run yarn dev:dashboard to start the dashboard server.