Skip to content

Commit 1549b3c

Browse files
docs: update project setup guide
1 parent 082bf8f commit 1549b3c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ Hi! We're really excited that you're interested in contributing! Before submitti
1010

1111
## Project setup
1212

13-
In order to run the Globalping API locally you will need Node.js 20 and Redis with [RedisJSON](https://oss.redis.com/redisjson/) module and MariaDB. All of them are included in docker-compose.yml file. You will also need to run a development instance of the [Globalping Probe](https://github.com/jsdelivr/globalping-probe) at the same time when testing.
13+
In order to run the Globalping API locally you will need Node.js 20 and Redis with [RedisJSON](https://oss.redis.com/redisjson/) module and MariaDB. All of them are included in docker-compose.dev.yml file. You will also need to run a development instance of the [Globalping Probe](https://github.com/jsdelivr/globalping-probe) at the same time when testing.
1414

1515
The API uses 3000 port by default. This can be overridden by `PORT` environment variable.
1616

1717
You can run the project by following these steps:
1818

1919
1. Clone this repository.
20-
2. `docker-compose up -d` - Run Redis and MariaDB
20+
2. `docker compose -f docker-compose.dev.yml up -d` - Run Redis and MariaDB
2121
3. `npm install && npm run download:files`
2222
4. Run `npm run start:dev`
2323

0 commit comments

Comments
 (0)