Fcmam5 / algeria-api

The πŸ‡©πŸ‡Ώ API (Work in progress)

Home Page:https://algeria-api.herokuapp.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

The πŸ‡©πŸ‡Ώ API (Work in progress)

https://algeria-api.herokuapp.com

License:MIT License


Languages

Language:JavaScript 99.9%Language:Shell 0.1%