To see the frontend, refer to the following link: finman-frontend.
Folder Structure • Getting Started • Usage
.
├── documents # Documentation files
│ ├── Contract # Social Contract
│ ├── Database # ER Diagram
│ ├── Individual Reflections
│ ├── Project Scope
│ ├── Team Reflection
│ └── Template # Co-author commit template
└── backend # Backend related files
└── src
├── main
│ ├── java/net/finman
│ │ ├── controller # Exposed endpoints to our api
│ │ ├── dao # Queries to the database
│ │ ├── exception # Exceptions
│ │ ├── mapper # Converts SQL records to POJOs
│ │ ├── model # POJOs
│ │ └── service # Business logic
│ └── resources # Config, schema, and inserts
└── test/java/net/finman # Test files
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
- Java 1.8 or later
- Maven 3.2+
- PostgreSQL 9.5 or later
- Clone the repo
# Clone this repository
$ git clone https://github.com/Puh00/finman-api
# Go into the repository
$ cd finman-api
# Go into the backend sub-directory
$ cd backend
- Add
postgresql
credentials to yourapplication.properties
:
# for your database credentials
spring.datasource.url=URL_TO_YOUR_DATABASE
spring.datasource.username=YOUR_USERNAME
spring.datasource.password=YOUR_PASSWORD
# if you decide to use a schema in spring
spring.sql.init.enabled=true
spring.sql.init.schema-locations=classpath:/schema.sql
spring.sql.init.continue-on-error=true
- Run the application from your favourite editor or from the command line:
- Requires Maven
# Run Spring Boot app using Maven, by default, the app runs on port 8080
$ mvn spring-boot:run
For instruction on how to interact with the api, please refer to the API documentation.