Project Documentation
Overview The StoreGest is an e-commerce platform built using Go, designed to manage various features related to food, photos, users, orders, and money.
Features
- Food management
- Photos management
- Users management
- Orders management
- Money management
- Authentication and authorization
Capabilities
- Handles multiple services and routes for each feature
- Uses middlewares for authentication and authorization
- Connects to a PostgreSQL database using the
DSN environment variable
Version v1.1.0
.env File Explanation The .env file is used to store sensitive information such as database credentials, API keys, and other configuration settings. This file should not be committed to version control systems (VCS) for security reasons.
How to Run the Project
- Create a new directory for your project and navigate into it.
- Clone the repository using
git clone <REPOSITORY URL>.
- Install dependencies by running
go mod download.
- Set environment variables in the
.env file (do not commit this file).
- Run the project using
go run main.go.
Note The project uses a PostgreSQL database, so ensure you have a connection to one before running the project.
This documentation provides an overview of the project’s capabilities and features. It also explains the purpose of the .env file and how to execute the project.
As a developer or recruiter for this project, you can use this document as a reference guide to understand the scope and requirements of the e-commerce platform.
License
The project use a licensed under the MIT License, which allows for free usage, modification, and distribution of the code.