- Node (>= v21.0.0)
- Go
- Bun
- Turbo
To get started with this template, simply paste this command into your terminal:
pnpm install && pnpm install -g turbo && cp apps/aqua/.env.example apps/aqua/.env &&
pnpm run db:migrateRunning on a Mac may also require adding @libsql/darwin-x64 dependency
To start the development server run:
turbo dev --filter=@teal/aquaOpen http://localhost:3000/ with your browser to see the home page. You will need to login with Bluesky to test the posting functionality of the app. Note: if the redirect back to the app after you login isn't working correctly, you may need to replace the 127.0.0.1 with localhost.
Still a work in progress and may have some hiccups
It is recommended if you are running aqua to make a publicly accessible endpoint for the app to post to. You can do that a couple of ways:
- Set up the traditional port forward on your router
- Use a tool like ngrok with the command
ngrok http 8080or Cloudflare tunnels (follow the 2a. portion of the guide when you get to that point).
If you do the cloudflare tunnels for amethyst as well, you will also need to follow this for routing to work properly. Although you can just run it locally and it will work.
- copy .env.template and name it .env. The docker build will pull everything from this
.env. There are notes in the .env.template on what some of the values should be. - Follow the instructions in piper to set up environment variables for the music scraper. But name it
.env.air
- Make sure docker and docker compose is installed
- It is recommended to run 'docker compose -f compose.dev.yml pull' to pull the latest remote images before running the docker compose command.
- Run
docker compose -f compose.dev.yml up -d
And that's it! You should have the full teal.fm stack running locally. Now if you are working on aqua you can do docker container stop aqua-app and run that locally during development while everything else is running in docker.