Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.68 KB

README.md

File metadata and controls

59 lines (39 loc) · 2.68 KB
Raw

funStoreHub Golang API

Your Favorite Club's Sports Center Store API

Introduction

Welcome to the funStoreHub Golang API, powering the backend for your favorite club's sports center store. This API allows seamless interaction with the funStoreHub frontend, enabling users to create, display, edit, and delete products specific to their beloved team.

Visual Helper

funStoreHub API Demo(Coming Soon) Click on the image to watch a demonstration of funStoreHub Golang API in action. COMING SOON

Installation Instructions

For Technical Users

  1. Clone the API repository: https://github.com/Njoxpy/FanHubStore-api
  2. Navigate to the project directory: cd funStoreHub-api
  3. Install Golang dependencies: go get ./...
  4. Set up the database (follow instructions in choose your favourite db), personally I have chosen postGres.
  5. Configure environment variables (check .env for reference).
  6. Run the API server: go run main.go or you can use Com[ileDaemon for automatic build] CompileDaemon -command="./FanHubStore-api"

For Non-Technical Users

The API is essential for the functioning of funStoreHub. Technical users will handle the installation and setup to ensure a smooth shopping experience for you on our funStoreHub website(Comig Soon).

Developer Instructions

I do encourage developers to contribute to the funStoreHub Golang API. Follow these steps to contribute:

  1. Fork the API repository.
  2. Create a new branch: git checkout -b feature/new-feature
  3. Make your changes and commit: git commit -m "Add new feature"
  4. Push to the branch: git push origin feature/new-feature
  5. Create a pull request.

Contributors Expectation

We appreciate your contribution to improving the funStoreHub Golang API. Please adhere to the following guidelines:

  • Follow the code of conduct.
  • Maintain code quality and consistency.
  • Document any new features or changes thoroughly.
  • Participate in discussions on our community forum for support and collaboration.

Known Issues (Work in Progress)

  • Issue 1: [Description of issue 1]
  • Issue 2: [Description of issue 2]

Feel free to contribute to resolving these issues or report new ones on our issue tracker. Together, let's enhance the funStoreHub Golang API for an even better shopping experience!

Code Explanation Part 1 Code Explanation Part 2