You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-27Lines changed: 14 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,26 +29,21 @@ This is the backend of the IroCO2 application. Developed using Java 21 and Sprin
29
29
30
30
### Run in development
31
31
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)
33
33
34
-
1. Start the database and tools:
34
+
2. Start the database and localstack :
35
+
- With Docker Compose (recommended)
35
36
```bash
36
37
docker compose -f docker/local.docker-compose.yml up -d
37
38
```
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
52
47
---
53
48
54
49
## 📦 Project Structure
@@ -68,7 +63,7 @@ This is the backend of the IroCO2 application. Developed using Java 21 and Sprin
68
63
mvn test
69
64
```
70
65
- 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
72
67
73
68
## 🛡️ Security & Auth
74
69
@@ -85,6 +80,7 @@ We use [Prettier Java](https://github.com/jhipster/prettier-java) to ensure cons
85
80
86
81
1. Install Node modules:
87
82
```bash
83
+
npm install
88
84
npm ci
89
85
```
90
86
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
102
98
npx prettier --write "**/*.java"
103
99
```
104
100
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:
0 commit comments