samuelselasi/KnowAfrika-API

Accessible API to know Africa # KnowAfrika API ***Accessible API to know Africa*** ## Content * About * Installation * Usage * Features * Contributing * License * Authors ## About The inception of the `KnowAfrika` API was motivated by our aspiration to offer a solution focused on acquiring a deeper understanding of Africa through an `API` service. We firmly believe in the transformative potential of technology to democratize information. Our overarching mission is to enhance the accessibility of information about Africa, making it readily available to individuals not only across the continent but also worldwide. ## Installation Refer to backend directory for detailed information on installation and environment requirements ## Usage ### API Access * **Base url** -> `127.0.0.1` * **SWagger docs** -> `127.0.0.1` ### API Requests * **Curl** -> On command terminal * **Browser** ***find out more in technical documentation page*** ## Features | Feature | Description | Directory | | --- | --- | --- | | Landing Page | Page containing information on the project and contacts of contributers | Web Static | | Technical Documentation Page | Page containing technical documentation of API | Web Static | | User Modules | Router containing endpoints with CRUD functions on `User` modules | Users | | Authentication | Router containing endpoints with CRUD functions on user `authentication` | Authentication | | Regions | Router containing endpoints with CRUD functions on `regions` of Africa | Regions | | Countries | Router containing endpoints with CRUD functions on African `countries` | Countries | | Provinces | Router containing endpoints with CRUD functions on `provinces` of African countries | Provinces | | Cities | Router containing endpoints with CRUD functions on `cities` of provinces in African countries | Cities | | Attractions | Router containing endpoints with CRUD functions on `attractions` of cities in African countries | Attractions | | Flags | Router cont …