pinned-front

Pinned Front

A modern, high-performance web application built with Go and Fiber framework, designed to manage guests, employees, places, and menus in a restaurant or hospitality environment.

🚀 Features

• High Performance: Built with Fiber, a fast and efficient web framework
• Modern Architecture: Clean code structure following domain-driven design principles
• Security: Built-in CSRF protection and input validation
• Scalable: Containerized with Docker and Kubernetes support
• Developer Friendly: Hot-reload support with Air
• Environment Configuration: Flexible configuration management with environment variables

🛠️ Tech Stack

• Backend: Go 1.18+
• Web Framework: Fiber v2
• Template Engine: Fiber Template
• Containerization: Docker & Docker Compose
• Orchestration: Kubernetes
• Development: Air for hot-reload
• Environment: Go-ENV for configuration management

📋 Prerequisites

• Go 1.18 or higher
• Docker and Docker Compose (for containerized deployment)
• Make (for using Makefile commands)

🚀 Getting Started

1. Clone the repository:

git clone https://github.com/patricksferraz/pinned-front.git
cd pinned-front

1. Copy the example environment file:

cp .env.example .env

1. Run the application:

For development:

make dev

For production:

make build
make run

Using Docker:

docker-compose up

🏗️ Project Structure

.
├── app/            # Application layer (handlers, routes)
├── config/         # Configuration management
├── domain/         # Domain layer (services, models)
├── utils/          # Utility functions
├── k8s/            # Kubernetes configurations
├── .docker/        # Docker-related files
└── .github/        # GitHub workflows and templates

🔧 Configuration

The application can be configured using environment variables. See .env.example for available options.

🧪 Testing

make test

📦 Deployment

Docker

docker-compose up -d

Kubernetes

kubectl apply -f k8s/

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📝 License

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

👨‍💻 Author

Patrick Sferraz

🙏 Acknowledgments

• Fiber - Fast and efficient web framework
• Air - Live reload for Go applications
• All other open-source projects that made this possible