readme.md

{Your App} Name

This Project is being developed by GG-Team

Project Structure and Explanation is below:

-docs
 -sql
 -swagger
 -templates
-env
-etc
 -cfg
 -tpl
-src
 -business
  - domain
  - entity
  - usecase
 -cmd
 -handler
-utils
 -config

1. docs

   This files contain sql file that store all of our migration file. Next is swagger where we can access/debug our API. For now, just ignore templates file.

2. env

   For the sake of simplicity, we using docker-compose to make our enviroment same when developing. You can run it with

   $ cd env | docker compose up -d

   or if you using docker-compose

   $ cd env | docker-compose up -d

   In the docker compose file, there are redis and mysql. If you already have mysql in your machine, just comment it, and run the docker compose command to avoid conflict with your local db.

3. etc

   This is where we store our config file as a .json . You can use the conf.template.json to construct your config.

4. src

   The main source code of the project. You can see the business folder contain some files. I recommend you to familliar with these files, because you will see/edit them a lot in the future.

   domain as name implies a source code to handling in the domain layer. If you not familiar with this term, imagine a model in Laravel. That is the domain. Their function is to "talking" with our storage (i.e database)

   entity is where we store all the type of our object in here. People often said it as data transfer object or dto in short. Many name, but same function.

   usecase is where the main logic of our source code. Its function is pretty similliar to controller in Laravel.

   The other folder are cmd and handler. As the name implies, cmd folder only have our main.go. In the other hand, handler is the folder where we define all the routes and their respective handler function.

5. utils

   This is where we read the config file from before and insert the environment variable to our source code.

How to run this ??

1. Make sure you have golang installed on your machine

2. Run the docker compose to run some container like Redis and MySQL DB

3. Make your config file

4. If you running on windows OS, makse sure to install make command API on your system. This will make your life easier. After that, you can run command:

   $ make swaggo

   this command will install swaggo a package to make an interface to access your endpoint in back end services.

5. Start the app with command (Linux or MAC) / in windows, you can read reference how to have make command either using WSL or git bash

   $ make run

6. The app is running on port 8080 (Default). If running, you will something like this on your terminal:

7. You can access the swagger endpoint in {host}:{port}/swagger/index.html

Secret that must be configured within the github repo

1. CADDY_HOST_NAME --> Domain Name for Caddy
2. DATABASE_DRIVER --> Database driver for example: MySQL or Postgres
3. DATABASE_HOST --> Database Host or IP Address
4. DATABASE_NAME --> Database Name
5. DATABASE_PASSWORD --> Database Password
6. DATABASE_PORT --> Database Port
7. DATABASE_USER --> Database User
8. DEPLOY_FILE --> Deploy Folder in VPS Host
9. DISCORD_AVATAR --> Discord Avatar for CICD Notification
10. DISCORD_USERNAME --> Discord Username for CICD Notification
11. DISCORD_WEBHOOK --> Discord Webhook for CICD Notification
12. DOCKERHUB_TOKEN --> Dockerhub token
13. DOCKERHUB_USERNAME --> Dockerhub username
14. ENV_MODE --> ENV Mode for App (debug)
15. HOST --> What is the host for VPS (localhost)
16. PORT --> What is the port for (8080)
17. REDIS_HOST --> What is the redis host
18. TOKEN_GITHUB --> Github Token
19. VPS_HOST --> What is the VPS IP Address
20. VPS_PASSWORD --> What is the VPS Password
21. VPS_PORT --> What is the SSH Port for VPS
22. VPS_USERNAME --> What is the SSH Username for VPS