prmv

README

PRMV

Uses

• Golang 1.22
• PostgreSQL 15

Requirements

• Docker
• Docker Compose

Installation

1. Clone this repository:

   git clone https://github.com/rostis232/prmv.git
   cd prmv
   

2. Rename the file .env.example to .env

   mv .env.example .env
   

3. Fill in the environment variables (or use default):

   PG_PORT= 
   PG_PASS=
   PG_USER=
   PG_DB_NAME=
   PORT=
   

4. Start Docker Compose:

   docker-compose up -d
   

   or use Makefile:

   make up
   

   This will run docker containers with the application and the PostrgeSQL database.

Usage

The web portal will be available once Docker Compose is up and running.

Migrations

App uses golang-migrate for mirgations handling. Migrations are applied independently when building containers.

OpenAPI documentation

There is Swagger documentation generated by swaggo/swag and available on the endpoint /swagger/index.html. Note that it is configured to work with localhost:8080.

Contact

• Telegram: rostis232
• Email: rostislav.pylypiv@gmail.com
• LinkedIn: Rostyslav Pylypiv

License

This project is licensed under the MIT License. See the LICENSE file for details.