haqqman/addressdata

Open Source Nigeria Address Data # AddressData **AddressData** is an address intelligence platform purpose-built for Nigeria. It provides developers, businesses, and operations with tools to validate, store, and retrieve Nigerian address data in a structured, efficient, and scalable way. ## Project Overview The platform consists of: - A **Portal** for users to submit and manage addresses. - A **Console** for manual verification, user management, and API key management. - A **Developer API** for programmatic access to verified address data and Nigerian geographic information. ## Local Development Setup ### Prerequisites - **Node.js:** Version 20.x or later. (We recommend using nvm to manage Node.js versions). - **npm or yarn:** Package manager. - **Firebase Account:** You'll need a Firebase project to connect the application to. - **Git:** For version control. ### 1. Clone the Repository ```bash git clone cd addressdata ``` ### 2. Install Dependencies ```bash npm install # or # yarn install ``` ### 3. Set Up Firebase Project 1. Go to the Firebase Console. 2. Click on **"Add project"** and follow the steps to create a new Firebase project (e.g., `addressdata-dev`). 3. Once your project is created, navigate to **Project settings** (click the gear icon next to "Project Overview"). 4. Under the **"General"** tab, scroll down to **"Your apps"**. 5. Click on the **Web icon (` `)** to add a new web app. 6. Register your app (e.g., "AddressData Web"). You **do not** need to set up Firebase Hosting at this stage if you are just running locally. 7. After registering, Firebase will provide you with a `firebaseConfig` object. You will need these values for your `.env.local` file. ### 4. Configure Environment Variables Create a `.env.local` file in the root of the project and add your Firebase project configuration details: ```env NEXT_PUBLIC_FIREBASE_API_KEY="YOUR_API_KEY" NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN="YOUR_AUTH_DOMAIN" NEXT_PUBLIC_FIREBASE_PROJECT_ID="YOUR_PROJECT_ID" NEXT_PUBLIC_FIR …