document-manager

Go API for managing documents with a React frontend.

Screens

Landing Page

Login Page

Signup Page

Home Page

Upload Page

Settings Page

PDFviewer Page

Clone the Repository

git clone https://github.com/Josehpequeno/document-manager.git
cd document-manager

Run the latest version with docker-compose

cd docker && docker-compose up -d

If the containers are stopped, run the following command:

docker-compose start

Postgres will run on port 5432, pgAdmin on port 8080, and the application on port 3450, according to the credentials in the docker-compose.yml file.

Initialize environment variables

cd backend

chmod +x .initENV.sh && source .initENV.sh

Generate Swagger Documentation

Install Swag

go install github.com/swaggo/swag/cmd/swag@latest

Run Swag

swag init --parseDependency --parseInternal

Swagger Route

A documentação Swagger pode ser acessada em http://localhost:3450/swagger/index.html.

Tests

Test handlers:

cd api/handlers/ && GIN_MODE=release go test

System Requirements

Make sure you have Docker and Docker Compose installed.

Link to repository on DockerHub

The project's Docker image is available in the DockerHub repository.

• Run with Docker To run the application with Docker, use the following command:

  docker run -it --name test-document-manager --network host josehpequeno/document-manager:latest

  This will start the application in the Docker container and expose ports 3450, 3000 and 80 to the respective services.

License

This project is licensed under the MIT License.