Skip to content

Commit

Permalink
Trigger redeploy
Browse files Browse the repository at this point in the history
  • Loading branch information
chromium-52 committed Feb 8, 2024
1 parent 028af3a commit f09e952
Showing 1 changed file with 21 additions and 17 deletions.
38 changes: 21 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,30 @@ This project is the Java backend api scaffold for lucys-love-bus.
[![Coverage Status](https://coveralls.io/repos/github/Code-4-Community/lucys-love-bus-backend/badge.svg?branch=master)](https://coveralls.io/github/Code-4-Community/lucys-love-bus-backend?branch=master)

#### Complete Setup Guide
- See https://docs.c4cneu.com/getting-started/setup-local-dev/ for a complete setup guide for:
- Installing, creating, and running a local PostgreSQL database (`lucys-love-bus`)
- Configuring IntelliJ
- Installing Maven
- Installing Java 8
- Configuring project properties files
- Compiling and running the API

- See https://docs.c4cneu.com/getting-started/setup-local-dev/ for a complete setup guide for:
- Installing, creating, and running a local PostgreSQL database (`lucys-love-bus`)
- Configuring IntelliJ
- Installing Maven
- Installing Java 8
- Configuring project properties files
- Compiling and running the API

#### Compile the Code Base
- If `mvn clean install` fails because of `spotless:check`,
then run `mvn spotless:apply` to apply code formatting corrections before
re-running `mvn clean install`.

- If `mvn clean install` fails because of `spotless:check`,
then run `mvn spotless:apply` to apply code formatting corrections before
re-running `mvn clean install`.

#### Run the API
- The `ServiceMain.java` class has the main method for running the code, this can be run directly in IntelliJ.
- Alternatively: `mvn install` creates a jar file at:
`service/target/service-1.0-SNAPSHOT-jar-with-dependencies.jar`.
- This can be run from the command line with the command `java -jar service-1.0-SNA....`.

- The `ServiceMain.java` class has the main method for running the code, this can be run directly in IntelliJ.
- Alternatively: `mvn install` creates a jar file at:
`service/target/service-1.0-SNAPSHOT-jar-with-dependencies.jar`.
- This can be run from the command line with the command `java -jar service-1.0-SNA....`.

#### Hitting the API
- By default the API is accessible at `http://localhost:8081`.
- All routes have the `/api/v1` prefix to them.
- **Example**: the HTTP request to get all notes would be be: `GET http://localhost:8081/api/v1/notes`.

- By default the API is accessible at `http://localhost:8081`.
- All routes have the `/api/v1` prefix to them.
- **Example**: the HTTP request to get all notes would be be: `GET http://localhost:8081/api/v1/notes`.

0 comments on commit f09e952

Please sign in to comment.