Skip to content

Commit 4833da2

Browse files
committed
docs: add setup guide section to README.md
1 parent 6f84af3 commit 4833da2

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,19 @@ Backend for the DevLink platform - developed with Java Spring
1313
- [JUnit](https://junit.org/junit5/) as testing framework
1414
- [AssertJ](https://assertj.github.io/doc/) for assertions
1515
- [mockito](https://site.mockito.org/) for mocking
16-
- [Instancio](https://www.instancio.org/) for test data generation
16+
- [Instancio](https://www.instancio.org/) for test data generation
17+
18+
## Installation and Usage
19+
20+
1. Have [Docker](https://www.docker.com/) set up and running
21+
2. Clone the repository, e.g. with:
22+
```sh
23+
git clone https://github.com/DevLink-dev/devlink-backend-java.git
24+
cd devlink-backend-java
25+
```
26+
3. Make a **copy** of [`.env.example`](.env.example) and rename it to `.env` (will be git-ignored)
27+
4. Add your environment secrets to [`.env`](.env) (will be used by both the database and the Spring application)
28+
5. Start Docker containers for database and Spring application:
29+
```sh
30+
docker compose up -d
31+
```

0 commit comments

Comments
 (0)