Project architect: @alchemmist

Motivation: Text transmission is the foundation of civilization.

About: It's a course project in the first year of the bachelor’s course in Central University. This is application for a free paper book exchange. Admins can add specific places, in any cities, and the users can say: "Hey! I can give this book in this place". Other users who want to read the book click “✓” and make a handshake.

In this application we have three main services: backend (written on Java), frontend (written on JavaScript), auth-service (written on Go):

bookswap
├── auth-service
├── backend
└── frontend

Auth-service is a service for authentication with two basic routes. Using crypto for hashing passwords. Backend is a service with main bussines logic. The frontend is a basic React app.

For more information you can check the docs folder. For example, where you can read the API doc or see the database schema.

If you want to run the app locally, clone this repo and rename .env.example to .env. Then use Docker:

docker compose up --build

If you have questions about this repo or you want to contribute, write to actual project architect (check it in a first line of this README).

• @alchemmist as Anton Grishin