Skip to content
This repository was archived by the owner on Dec 4, 2024. It is now read-only.

Fcmam5/algeria-api

This branch is 1 commit ahead of develop.

Folders and files

NameName
Last commit message
Last commit date
Sep 11, 2020
Sep 11, 2020
Dec 4, 2020
Sep 11, 2020
Sep 11, 2020
Dec 4, 2022
Dec 21, 2019
Sep 11, 2020
Nov 23, 2019
Mar 1, 2020
May 3, 2020
Jun 15, 2019
Jun 2, 2019
Oct 31, 2019
Dec 4, 2020
Dec 22, 2019
May 25, 2019
Apr 21, 2021
Apr 4, 2021
Sep 11, 2020

Repository files navigation

Algeria API

Known Vulnerabilities Mutation testing badge

This is another Algerian administrative areas repository 😃. In this project we provide a structured JSON and XML data that can be found in results/WilayaList.json and results/WilayaList.XML or through our API: https://algeria-api.herokuapp.com/api/v1/

Features

API Documentation

Find the full API documentation here (Will be moved to a SWAGGER documentation).

TODOs & Future Improvements/Features

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with us before making a change. And also, please make sure to read our guidelines for contributing

Improving the API (new features, bug fixes...)

📝 🐳 🌐 🏗️ 🐛 ⚡ 👷 ✨

If you want to work on the API server, just pull this repository then run npm install

To run the development server

npm run server:dev
# or
yarn server:dev

To run in Docker

npm run docker:prod
# Or
yarn docker:prod

Improving the Wilayas List (translations, corrections...)

📝 🌐 🏗️ 🐛 ⚡ 👷 ✨

The wilaya models are auto-generated by crawling and by using the fine work of mohsenuss91/AlgerianAdministrativeDivision. If you want to contribute more by adding, correcting or improving the results... Please create an issue so we can discuss it, and then you just need to update the results on results/WilayaList.json

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments