Appearance

Development Environment ​

If you want to contribute to Claper, you can set up a development environment on your machine.

Setting up a development environment ​

Docker setup ​

To set up a development environment with Docker, you need to have Docker installed on your machine.

  1. Clone the repo
sh
git clone https://github.com/ClaperCo/Claper.git
  1. Go to the project directory
sh
cd Claper
  1. Run Docker compose
sh
docker compose -f compose.dev.yml up

Manual setup ​

To set up a development environment, you need to have the prerequisites installed on your machine.

  1. Clone the repo
sh
git clone https://github.com/ClaperCo/Claper.git
  1. Go to the project directory
sh
cd Claper
  1. Configure your environment variables
sh
cp .env.sample .env

Edit the .env file to match your configuration.

  1. Install dependencies
sh
mix deps.get
  1. Create your database
sh
mix ecto.create
  1. Migrate your database
sh
mix ecto.migrate
  1. Install JS dependencies
sh
cd assets && npm i
  1. Allow execution of startup file
sh
chmod +x ./dev.sh
  1. Start Phoenix endpoint with
sh
./dev.sh start

Database

You need a PostgreSQL database running on your machine. You can run it with a Docker container: docker run -p 5432:5432 -e POSTGRES_PASSWORD=claper -e POSTGRES_USER=claper -e POSTGRES_DB=claper --name claper-db -d postgres:15.

Now you can visit localhost:4000 from your browser.

If you have configured MAIL environment variable to local, you can access to the mailbox at localhost:4000/dev/mailbox.