erikrios / ponorogo-regency-api

API for Administrative Subdivisions of Ponorogo Regency (Districts and Villages)

Ponorogo Regency API

API for Administrative Subdivisions of Ponorogo Regency (Districts and Villages)
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Ponorogo Regency API is an open source project that provides API (Application Programming Interface) related to Ponorogo Regency subdivisions.

You can get all district and village data in Ponorogo Regency.

(back to top)

Built With

• Go
• PostgreSQL
• Echo

(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

1. Get a API Documentation at https://ponorogo-api.herokuapp.com/
2. Clone the repo

   git clone [email protected]:erikrios/ponorogo-regency-api.git

3. Install required dependencies

   go mod tidy

4. 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>

5. 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
  • Chinese
  • Spanish

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Erik Rio Setiawan - github - [email protected]

Project Link: https://github.com/erikrios/ponorogo-regency-api

(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!

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• GitHub Pages
• Font Awesome
• React Icons

(back to top)