command
module
Version:
v0.0.0-...-4bb33b9
Opens a new window with list of versions in this module.
Published: Jun 17, 2025
License: MIT
Opens a new window with license information.
Imports: 40
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
README
¶
Backend Setup Instructions
This document provides instructions for setting up and running the backend service.
Prerequisites
- Ensure you have Docker and Docker Compose installed on your machine.
- Make sure you have Go installed (version 1.16 or later).
Setup
-
Copy the Environment Variables File
Before starting the application, you need to create a .env file with your own configuration. Copy the example file provided:
cp .env.example .env
Update the .env file with your PostgreSQL credentials and desired application port.
-
Start the Database with Docker Compose
Use Docker Compose to start the PostgreSQL database. Run the following command in the root of your project directory:
docker-compose up -d
This command will start the database service in detached mode.
-
Build the Go Application
After the database is up and running, build the Go application:
go build
-
Run the Application
Finally, run the application:
./your_application_name
Replace your_application_name with the name of the binary generated by the go build command.
-
Access the Application
The application should now be running on the port specified in your .env file (default is 2121). You can access it via http://localhost:2121.
Troubleshooting
-
If you encounter issues with loading the .env file, ensure that the file is correctly named and located in the root of your project.
-
Check the logs of the Docker containers for any errors by running:
docker-compose logs
License
This project is licensed under the MIT License - see the LICENSE file for details.
Documentation
¶
There is no documentation for this package.
Source Files
¶
Click to show internal directories.
Click to hide internal directories.