File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff 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+ ` ` `
You can’t perform that action at this time.
0 commit comments