Table of Contents
-
About The Project
-
Getting Started
- Usage
- Roadmap
- Contributing
- License
- Contact
- Acknowledgments
About The Project
Reog Apps API is an open source project that provides API (Application Programming Interface) related to Reog Groups in Ponorogo.
(back to top)
Built With
(back to top)
Getting Started
Prerequisites
This is an example of how to list things you need to use the software and how to install them.
- Go
sudo apt install golang
Installation
- Get a API Documentation at http://103.183.74.19/
- Clone the repo
git clone git@github.com:erikrios/reog-apps-apis.git
- Install required dependencies
go mod tidy
- Enter your environment variables in
.env
ENV=<ENV>
PORT=<PORT>
DB_HOST=<POSTGRESQL_DB_HOST>
DB_PORT=<POSTGRESQL_PORT>
DB_USER=<POSTGRESQL_DB_USER>
DB_PASSWORD=<POSTGRESQL_DB_PASSWORD>
DB_NAME=<POSTGRESQL_DB_NAME>
JWT_SECRET=<JWT_SECRET>
PONOROGO_ADMINISTRATIVE_AREA_BASE_URL=<PONOROGO_ADMINISTRATIVE_AREA_BASE_URL>
ADMIN_USERNAME=<INITIAL_ADMIN_USERNAME>
ADMIN_NAME=<INITIAL_ADMIN_NAME>
ADMIN_PASSWORD=<INITIAL_ADMIN_PASSWORD>
MONGO_USERNAME=erikrios
MONGO_PASSWORD=erikrios
MONGO_HOST=localhost
MONGO_PORT=27017
- Run
go run main.go
(back to top)
Usage
For more examples, please refer to the Documentation
(back to top)
Roadmap
- Add Changelog
- Add back to top links
- Add Additional Templates w/ Examples
- Add "components" document to easily copy & paste sections of the readme
- Multi-language Support
See the open issues for a full list of proposed features (
and known issues).
(back to top)
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any
contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also
simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
)
- Commit your Changes (
git commit -m 'Add some AmazingFeature'
)
- Push to the Branch (
git push origin feature/AmazingFeature
)
- Open a Pull Request
(back to top)
License
Distributed under the MIT License. See LICENSE.txt
for more information.
(back to top)
Erik Rio Setiawan - github - erikriosetiawan15@gmail.com
Project Link: https://github.com/erikrios/reog-apps-apis
(back to top)
Acknowledgments
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites
to kick things off!
(back to top)