Add instructions on running the program to README
This commit is contained in:
34
README.md
34
README.md
@@ -1,5 +1,39 @@
|
|||||||
# Secure Notes Vault API
|
# Secure Notes Vault API
|
||||||
|
|
||||||
|
## Running the program
|
||||||
|
|
||||||
|
This project requires Java 21 and Maven. The API starts on `http://localhost:8080`.
|
||||||
|
|
||||||
|
For the fastest local setup, run the app with the in-memory H2 database:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make dev
|
||||||
|
```
|
||||||
|
|
||||||
|
To run the test suite:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make test
|
||||||
|
```
|
||||||
|
|
||||||
|
To run the API and PostgreSQL with Docker Compose:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
JWT_SECRET=dev-secret-change-me-do-not-use-in-production make docker-up
|
||||||
|
```
|
||||||
|
|
||||||
|
Stop the Docker Compose stack with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make docker-down
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also run the Spring Boot app directly:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
JWT_SECRET=dev-secret-change-me-do-not-use-in-production mvn spring-boot:run
|
||||||
|
```
|
||||||
|
|
||||||
## Design decisions
|
## Design decisions
|
||||||
- Java programming language since Bluestaq is a Java shop
|
- Java programming language since Bluestaq is a Java shop
|
||||||
- Maven for building
|
- Maven for building
|
||||||
|
|||||||
Reference in New Issue
Block a user