Skip to content

Commit 59173ac

Browse files
author
Victor LUCE
committed
docs: update README.md with installation fixes
1 parent f8c5101 commit 59173ac

File tree

1 file changed

+14
-27
lines changed

1 file changed

+14
-27
lines changed

README.md

Lines changed: 14 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -29,26 +29,21 @@ This is the backend of the IroCO2 application. Developed using Java 21 and Sprin
2929

3030
### Run in development
3131

32-
#### With Docker Compose (recommended)
32+
1. Create a `infrastructure/src/main/resources/application-local.properties` (ask an IroCO2 referent on how to document it)
3333

34-
1. Start the database and tools:
34+
2. Start the database and localstack :
35+
- With Docker Compose (recommended)
3536
```bash
3637
docker compose -f docker/local.docker-compose.yml up -d
3738
```
38-
2. Run the backend (in another terminal):
39-
```bash
40-
mvn spring-boot:run
41-
```
42-
43-
#### Without Docker
44-
45-
- Make sure a PostgreSQL instance is running and accessible (see `docker/local.docker-compose.yml` for env vars).
46-
- Update the `application.properties` or use environment variables as needed.
47-
- Run:
48-
```bash
49-
mvn spring-boot:run
50-
```
51-
39+
- Without Docker
40+
41+
Make sure a PostgreSQL and a Localstack instance are accessible (see `docker/local.docker-compose.yml` for env vars).
42+
43+
3. On IntelliJ, create a configuration to launch the app with local profile :
44+
- in `infrastructure/src/main/java/MainApp.main`, right-click on the run button associated to`main`function
45+
- edit a configuration where you simply add `-Dspring.profiles.active=local` as a CLI argument
46+
4. Run `MainApp.main` with the configuration you just created
5247
---
5348

5449
## 📦 Project Structure
@@ -68,7 +63,7 @@ This is the backend of the IroCO2 application. Developed using Java 21 and Sprin
6863
mvn test
6964
```
7065
- Cucumber BDD tests included
71-
- Testcontainers used for integration tests (PostgreSQL, Localstack)
66+
- Testcontainers used for integration tests (PostgreSQL, Localstack) so a Docker Daemon is needed
7267

7368
## 🛡️ Security & Auth
7469

@@ -85,6 +80,7 @@ We use [Prettier Java](https://github.com/jhipster/prettier-java) to ensure cons
8580

8681
1. Install Node modules:
8782
```bash
83+
npm install
8884
npm ci
8985
```
9086
2. (Recommended) Install the File Watchers plugin in your IDE and configure it as follows:
@@ -102,15 +98,6 @@ We use [Prettier Java](https://github.com/jhipster/prettier-java) to ensure cons
10298
npx prettier --write "**/*.java"
10399
```
104100

105-
### Git LF/CRLF configuration
106-
By default, Git on Windows may convert line endings (LF → CRLF). Our Prettier config enforces LF. To avoid unwanted conversions, run one of the following:
107-
108-
```bash
109-
git config --system core.autocrlf false # per-system
110-
git config --global core.autocrlf false # per-user
111-
git config --local core.autocrlf false # per-project
112-
```
113-
114101
---
115102

116103
## 🧭 Local SonarQube Usage
@@ -120,7 +107,7 @@ We use SonarQube for static code analysis and code quality.
120107
### Start SonarQube locally
121108

122109
```bash
123-
docker compose -f docker/local.docker-compose.yml up
110+
docker compose -f docker/sonar.docker-compose.yml up
124111
```
125112

126113
### Configuration

0 commit comments

Comments
 (0)