Adekemi02/locale_api

Locale is developer tool for anyone who needs to know Nigeria geopraphically. Locale's API shows you all Nigeria's regions, states, and local governement areas (LGAs). Locale is looking to be a very useful tool for the thousands of businesses building for Nigeria's 200M+ population size. # Locale API --- Explore the Docs » View Demo · Report Bug · Request Feature --- Table of Contents About Locale API Built With Lessons Learned Installation Usage Sample License Contact Acknowledgements back to top --- ## About Locale API Locale is a developer tool for anyone who needs to know Nigeria geographically. Locale's API shows you all of Nigeria's regions, states, and local government areas (LGAs). Locale is looking to be a handful tool for the thousands of businesses building for Nigeria's 200M+ population size. This project was built with Python's Flask-RESTX by Barakat Adisa as part of Backend Engineering final Semester Exam and Capstone Project at AltSchool Africa --- ## Built with --- ## Lessons Learned By creating this API, I was able to learn and understand the following concepts: * Caching * App Deployment with Render * MongoDB * Documentation * Debugging * Routing * Database Management * Rate Limiting * File Handling * Redis * User Authentication * User Authorization --- ## Installation 1. Clone the repo ```sh git clone github.com ``` 2. Navigate to the project directory ```sh cd locale_api ``` 3. Create a virtual environment ```sh python -m venv venv ``` 4. Install the required packages ```sh pip install -r requirements.txt ``` 5. Run the app ```sh flask run ``` 6. Open the app in your preferred browser by visiting: localhost. --- ## Usage To make use of this API, simply follow the following steps: 1. Open the app in your preferred browser by visiting: locale-2o8b.onrender.com. 2. Create a user account to unlock the full potential of the API. 3. Register as a user by clicking on 'auth' to reveal the dropdown menu for authentication and authorization. You can easily register via the 'api/v1/auth/register' route. 4. Once registered, sign in using the 'api/v1/auth/login' route to generate a JWT token. This token will grant you access t …