Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Fcmam5 committed Dec 4, 2020
1 parent d770622 commit 7d93eab
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,21 @@ This is another Algerian administrative areas repository :smiley:. In this proje

## Features

* Exposes a RESTful API
* JSON Files
* Postal codes by wilaya [results/postal-codes-results.json](./data/postal-codes-results.json)
* Wilayas list (with Dairas and Baladiyahs lists) [results/WilayaList.json](./data/WilayaList.json)
- Exposes a RESTful API
- JSON Files
- Postal codes by wilaya [results/postal-codes-results.json](./data/postal-codes-results.json)
- Wilayas list (with Dairas and Baladiyahs lists) [results/WilayaList.json](./data/WilayaList.json)

## API Documentation

Find the full API documentation [here](https://documenter.getpostman.com/view/6370698/SW12ywmH?version=latest) (*Will be moved to a SWAGGER documentation*).
Find the full API documentation [here](https://documenter.getpostman.com/view/6370698/SW12ywmH?version=latest) (_Will be moved to a SWAGGER documentation_).

## TODOs & Future Improvements/Features

* Add Tamazight Translation
* Build a dashboard to manage/correct data
* Match each postal code withe its provinces
* Add long/latt cordinates
* Improve data validation (see [`tools/validateDataSchemas.js`](./tools/validateDataSchemas.js) and [`data/WilayaList.schema.json`](./data/WilayaList.schema.json))
- Build a dashboard to manage/correct data
- Match each postal code withe its provinces
- Add long/latt cordinates
- Improve data validation (see [`tools/validateDataSchemas.js`](./tools/validateDataSchemas.js) and [`data/WilayaList.schema.json`](./data/WilayaList.schema.json))

## Contributing

Expand Down Expand Up @@ -61,6 +60,6 @@ This project is licensed under the MIT License - see the [LICENSE](./LICENSE) fi

## Acknowledgments

* [mohsenuss91/AlgerianAdministrativeDivision](https://github.com/mohsenuss91/AlgerianAdministrativeDivision)
* [AbderrahmeneDZ/Wilaya-Of-Algeria/Wilaya_Of_Algeria.json](https://github.com/AbderrahmeneDZ/Wilaya-Of-Algeria/blob/master/Wilaya_Of_Algeria.json)
* Postal codes and Dairas list are collected by crawling the [Algérie Poste](https://www.poste.dz/) and [Interior ministry](http://www.interieur.gov.dz/) websites, the scripts I used are in [tools/](./tools/README.md)
- [mohsenuss91/AlgerianAdministrativeDivision](https://github.com/mohsenuss91/AlgerianAdministrativeDivision)
- [AbderrahmeneDZ/Wilaya-Of-Algeria/Wilaya_Of_Algeria.json](https://github.com/AbderrahmeneDZ/Wilaya-Of-Algeria/blob/master/Wilaya_Of_Algeria.json)
- Postal codes and Dairas list are collected by crawling the [Algérie Poste](https://www.poste.dz/) and [Interior ministry](http://www.interieur.gov.dz/) websites, the scripts I used are in [tools/](./tools/README.md)

0 comments on commit 7d93eab

Please sign in to comment.