🚀 Tech Stack

Go, Gin, Gorm, Postgresql, Docker

🧞 Simple Running Project

if you use Linux or WSL you can use a script.

how to run?

• Make sure the script is executable:

  chmod +x script.sh

• Then you can type:

   ./script.sh -h

  you will get various information to carry out the project.

want to make it easier to use the database with docker?

• You can run it using docker compose
  • Run docker

     docker compose up -d

  • Stop docker

     docker compose down

🚀 Contribute

How to contribute?

1. Fork the Repository:

   • Go to the repository page.
   • Click on the "Fork" button in the top-right corner of the page.
   • This will create a copy of the repository in your own GitHub account.

2. Clone Your Fork:

   git clone https://github.com/yourusername/go-ngodeyuk-core-project.git
   cd go-ngodeyuk-core-project

3. Create a Branch:

   git checkout -b your-feature-branch

4. Make Your Changes:

   • Add your features or bug fixes.
   • Ensure your code follows the project's coding standards.

5. Commit Your Changes:

   examples:

   git add .
   git commit -m "build: features(users) register service"

   Rules commit :

   • build : used when you want to create something new.
   • feat : used when you want to add features to existing code.
   • refactor : used when you want to change existing code.
   • fix : used when you have successfully fixed a bug.
   • docs : used when you have written project documentation.

6. Create a Pull Request:

   • Go to the original repository.
   • Click on the Pull Requests tab.
   • Click on the New Pull Request button.
   • Select your feature branch from the "compare" dropdown.
   • Click Create Pull Request and provide a description of your changes.

⚙️ License

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