README.md

Backend part of social network for travelers Finch

References

See Frontend Repository here (React Native iOS app)

Reviews

• Academic Adviser Review by Alexandrov D. V.

Documentation

GOST 19 (Russian Software Documentation Standard ГОСТ 19 ЕСПД) documentation

1. Explanatory Note
2. Requirements. Backend
3. Requirements. Backend & Frontend
4. Testing Plan & Methodology. Backend
5. Testing Plan & Methodology. Backend & Frontend
6. Programmer's Guide
7. Program Sources

Local Deployment Guide

1. You should use Java 11 to build and run this project
2. Install PostgreSQL 13 with username {dbusername} and password {dbpassword}
3. Create database with name {dbname}

> psql -U {dbusername}
# CREATE DATABASE {dbname};

4. Clone this repository
5. Open application-local.properties file and configure your database:

spring.datasource.url=jdbc:postgresql://localhost/{dbname}
spring.datasource.username={dbusername}
spring.datasource.password={dbpassword}

6. Open application.properties and set active profile to local:

spring.profiles.active=local

7. (Optional) Open StartupRunner.java and uncoment line 68 (//generateMockData();) - this will add some mock users and posts to the database (if you've generated them once, you should comment this line back to avoid collisions on app restart). Then create folder /images/ in the projects root directory and extract the archive there (do not change images names!)
8. Run following commands in project's root directory:

> ./gradlew clean
> ./gradlew bootRun

9. The application is now up and running. You can send your requests to localhost:8080

• You can access Swagger2 page at http://localhost:8080/swagger-ui.html
• You can also use this Postman requests collection to send requests. Use this guide to learn how to import request collections via link in postman