Human Livestocks

Not your usual starboard bot.

Develop

This is a Turborepo.

Environment Variables

There are .env.example files located in the root and apps/packages folders. These files contain the environment variables required to run the project. Copy the contents of the .env.example file to a new .env file and fill in the values.

• /.env.example
• /apps/web/.env.example
• /apps/bot/.env.example
• /packages/db/.env.example

Get Started

To develop all apps and packages, run the following commands:

pnpm install # install dependencies
pnpm dev # start apps and redis container

Build

The entire project can be dockerised and run with the following command:

docker compose up

If you encounter any issues with the web dashboard, especially if changing the output environment variable, delete the .next folder and rebuild.

Remote Caching

To speed up Docker build times, complete the .env file in the root. More information can be found here.

Deployment

Currently, the web application is deployed on Netlify and the bot is dockerised and deployed on a VPS.

Useful Commands

docker compose -f docker-compose.local.yml up -d
docker compose down
pnpm [command] --filter package_name