hippofish/docs/development.md

Firefish Developer Docs

Containerized Environment

The Firefish repo comes with a new containerized environment to help make development!

Prerequisites

• Latest Docker installation
  • Alternatively, you can use Podman and Podman Compose.
• The following ports are not in use
  • 3000
  • 25432
  • 26379

Start up the environment

1. Run git clone https://firefish.dev/firefish/firefish.git && cd firefish to fetch needed files.
   • If you don't want to clone the entire repository, you can just download the dev directory and execute chmod +x dev/docker-entrypoint.sh.
2. Open dev/docker-compose.yml and set FIREFISH_URL to the URL you want to use (or leave it to http://localhost:3000).
3. Run docker compose --file dev/docker-compose.yml up. This will build the environment, dependencies and prepare the needed config files.
   • If you use Podman, you should run podman-compose --file dev/docker-compose.yml up instead.
4. Wait until the following message shows up.

   DONE *  [core boot]     All workers started
   DONE *  [core boot]     Now listening on port 3000 on https://your_firefish_url.example.com
   

5. A fresh Firefish environment is created on the URL you have set!

When you want to restart the dev server, you just need to terminate the process (a.k.a. press Ctrl+C) and run docker compose up again.