Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fityannugroho/idn-area

API that provides information about Indonesia administrative area, based on the latest official data 🇮🇩
https://github.com/fityannugroho/idn-area

api hacktoberfest idn-area indonesia island nodejs open-source openapi typescript wilayah wilayah-indonesia

Last synced: 3 days ago
JSON representation

API that provides information about Indonesia administrative area, based on the latest official data 🇮🇩

Host: GitHub
URL: https://github.com/fityannugroho/idn-area
Owner: fityannugroho
License: mit
Created: 2022-02-20T04:26:14.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-10-30T02:59:51.000Z (3 months ago)
Last Synced: 2024-10-30T05:15:25.248Z (3 months ago)
Topics: api, hacktoberfest, idn-area, indonesia, island, nodejs, open-source, openapi, typescript, wilayah, wilayah-indonesia
Language: TypeScript
Homepage: https://idn-area.up.railway.app
Size: 4.44 MB
Stars: 102
Watchers: 2
Forks: 15
Open Issues: 4
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        
Indonesian Area API




  

  

  

  

  

  



**English** | [हिन्दी](docs/README_hi.md) | [Bahasa Indonesia](docs/README_id.md) | [한국어](docs/README_ko.md) | [Tagalog](docs/README_tl.md)

API that provides information on the **administrative areas of Indonesia**, from the province, regency, district, to village levels. It also provides island data since [version 1.1.0](https://github.com/fityannugroho/idn-area/releases/tag/v1.1.0).

Built with [NestJS framework](https://nestjs.com) and writen in TypeScript. [Prisma](https://www.prisma.io) is used as the ORM to interact with any kind of databases.

> **Note!**

>

> If you choose MongoDB as the [database provider](/docs/installation.md#prerequisite), **the `id` property will be added to the response**. See [issue #308](https://github.com/fityannugroho/idn-area/issues/308).

>

> _This `id` property is **not present** if you use another database providers._

## Getting Started

Please read the [installation guide](docs/installation.md) to install and run this app.

[![Deploy on Railway](https://railway.com/button.svg)](https://railway.app/template/9Tcyq9?referralCode=ho_K6W)

## Data

The data we used is based on official sources, managed in [**idn-area-data**](https://github.com/fityannugroho/idn-area-data) repository and distributed as a [npm package](https://www.npmjs.com/package/idn-area-data).

> The [data](https://github.com/fityannugroho/idn-area-data/tree/main/data) is made available here under the [Open Database License (ODbL)](https://github.com/fityannugroho/idn-area-data/blob/main/data/LICENSE.md).

## Documentation

Read the latest version of API documentation in the [documentation page](https://idn-area.up.railway.app). This documentation is automatically generated using [`@nestjs/swagger`](https://docs.nestjs.com/openapi/introduction).

> You also can access the documentation in your local machine by running the app (see [Getting Started](#getting-started)) and open http://localhost:3000 in your browser.

## Live Demo

You can try the API by replacing the http://localhost:3000 with the endpoint provided in this repository description.

These are some sample projects that using this API :

- [idn-area Map](https://github.com/fityannugroho/idn-area-map)

## Contributing

If you want to contribute to this project, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file and make sure you follow the [Pull Request guide](CONTRIBUTING.md#submitting-a-pull-request).

## Problem Reporting

We have different channels for each problem, please use them by following these conditions :

### Reporting a Bug

To report a bug, please open a new issue following the [guide](CONTRIBUTING.md#submitting-an-issue).

### Requesting a New Feature

If you have a new feature in mind, please open a new issue following the [guide](CONTRIBUTING.md#submitting-an-issue).

### Asking a Question

If you have a question, you can search for answers in the [GitHub Discussions Q&A category](https://github.com/fityannugroho/idn-area/discussions/categories/q-a). If you don't find a relevant discussion already, you can open a new discussion.

## Support This Project

Give a ⭐️ if this project helped you!

Also please consider supporting this project with a **donation**. Your donation will help us maintain and develop this project and provide you with better support.