modulepackage
0.0.0-20240929031320-e913fcb53a35
Repository: https://github.com/symbiosix/progressieapi.git
Documentation: pkg.go.dev
# README
Progressie API
RESTful Progressie Academy API Services. Built to ensure Progressie Services are good to be served!
Development Inquiry
Simply fork this repository. Then follow these steps :
1. cmd: cd ProgressieAPI || cd <your-project>
2. cmd: go get -u
3. copy the .env.example file and paste + rename it into .env
4. open the .env and fill the corresponding environment variables (the values will be shared only among owners)
5. do your assigned job properly
6. do not forget to add API Documentation comments in your service file (example: services/auth/index.go)
7. cmd: swag fmt
8. cmd: swag init
9. make sure the swag has no error on parsing your API Docs comments (if error, pls check Swagger Docs in References section for fix)
10. cmd: go run main.go
11. make sure that firewall allow access popped up + allowed and no errors/conflicts (bugs are tolerated, but beware).
12. cmd: git checkout -b [YOUR_BRANCH]
13. cmd: git commit -am '[YOUR COMMIT MESSAGES]'
14. cmd: git push origin [YOUR_BRANCH]
15. Create New Pull Request
References
# Packages
Package docs Code generated by swaggo/swag.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
LivenessCheck godoc
@Summary Get Liveness Check Status @Description Get Liveness Check Status @Tags CheckUp @Produce plain @Router /liveness-check [get].
HealthCheck godoc
@Summary Get API Health Check Status @Description Get API Health Check Status @Tags CheckUp @Produce json @Success 200 {object} status.HealthMap @Failure 500 {object} status.HealthMap @Router /healthcheck [get].
# Variables
No description provided by the author
No description provided by the author
TODO: Create New Service Controller and Router Variables.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author