Skip to content

Commit 768163a

Browse files
committed
Add Docker image for dev
1 parent 78629c5 commit 768163a

File tree

2 files changed

+28
-2
lines changed

2 files changed

+28
-2
lines changed

self-hosting/development.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,30 @@ If you want to contribute to Claper, you can set up a development environment on
44

55
## Setting up a development environment
66

7+
### Docker setup
8+
9+
To set up a development environment with Docker, you need to have [Docker](https://docs.docker.com/engine/install/) installed on your machine.
10+
11+
1. **Clone the repo**
12+
13+
```sh
14+
git clone https://github.com/ClaperCo/Claper.git
15+
```
16+
17+
2. **Go to the project directory**
18+
19+
```sh
20+
cd Claper
21+
```
22+
23+
3. **Run Docker compose**
24+
25+
```sh
26+
docker compose -f compose.dev.yml up
27+
```
28+
29+
### Manual setup
30+
731
To set up a development environment, you need to have the [prerequisites](/self-hosting/prerequisites) installed on your machine.
832

933
1. **Clone the repo**
@@ -60,6 +84,8 @@ chmod +x ./dev.sh
6084
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`.
6185
:::
6286

87+
---
88+
6389
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
6490

6591
If you have configured `MAIL` environment variable to `local`, you can access to the mailbox at [`localhost:4000/dev/mailbox`](http://localhost:4000/dev/mailbox).

self-hosting/prerequisites.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
You can choose to run Claper directly in your server environment or use Docker to run it in a container. If you decide **not to use Docker**, you need to have the following prerequisites:
44

55
- Postgres >= 15
6-
- Elixir >= 1.16.2
7-
- Erlang >= 26
6+
- Elixir = 1.16.2 (OTP 26)
7+
- Erlang = 26.2.1
88
- NPM >= 10
99
- NodeJS >= 20
1010
- Ghostscript >= 10 (for PDF support)

0 commit comments

Comments
 (0)