Yours Store E-Commerce Backend Rest API is a feature-rich backend solution for E-commerce applications developed using Golang with the Gin web framework. This API is designed to efficiently handle routing and HTTP requests while following best practices in code architecture and dependency management.
- Clean Code Architecture: The project follows clean code architecture principles, making it maintainable and scalable.
- Dependency Injection: Utilizes the Dependency Injection design pattern for flexible component integration.
- Compile-Time Dependency Injection: Dependencies are managed using Wire for compile-time injection.
- Database: Leverages PostgreSQL for efficient and relational data storage.
- AWS Integration: Integrates with AWS S3 for cloud-based storage solutions.
- E-Commerce Features: Implements a wide range of features commonly found in e-commerce applications, including cart management, wishlist, wallet, offers, and coupon management.
- Code Quality: Implements Continuous Integration(CI) with GitHub Actions.
For interactive API documentation, Swagger is implemented. You can explore and test the API endpoints in real-time.
To run the project locally, you can follow these steps:
- Clone the repository.
- Set up your environment with the required dependencies, including Golang, PostgreSQL, Docker, and Wire.
- Configure your environment variables (e.g., database credentials, AWS keys, Twilio credentials).
- Build and run the project.
Before running the project, you need to set the following environment variables with your corresponding values:
DB_HOST: Database hostDB_NAME: Database nameDB_USER: Database userDB_PORT: Database portDB_PASSWORD: Database password
DB_AUTHTOKEN: Twilio authentication tokenDB_ACCOUNTSID: Twilio account SIDDB_SERVICESID: Twilio services ID
AWS_REGION: AWS regionAWS_ACCESS_KEY_ID: AWS access key IDAWS_SECRET_ACCESS_KEY: AWS secret access key
Make sure to provide the appropriate values for these environment variables to configure the project correctly.