Help Map

Overview

Help Map is a web application developed by Code for Norway to assist individuals in need across Norway, such as the homeless, refugees, or those facing economic hardships. The platform enables users to locate places offering free essential services like food, clothing, and shelter on an interactive map. Users can also contribute by adding and editing locations to ensure the information remains up-to-date.

This project is built with Nuxt 3, uses Mapbox for interactive mapping, and integrates Supabase for backend services and data management.

Features

• Interactive Map: Visualize locations providing free services using Mapbox.
• User Contributions: Users can add and edit locations to keep the map current.
• Real-time Data: Powered by Supabase for efficient data storage and retrieval.
• Responsive Design: Built with Nuxt 3 for a seamless experience across devices.

Tech Stack

• Frontend: Nuxt 3 (Vue.js-based framework)
• Mapping: Mapbox for interactive and dynamic maps
• Backend: Supabase for authentication, database, and real-time updates

Getting Started

Prerequisites

• Node.js (v16 or higher)
• npm or Yarn
• A Mapbox account and API key
• A Supabase account and project setup

Installation

1. Clone the Repository:

   git clone https://github.com/codefornorway/help-map.git
   cd help-map

2. Install Dependencies:

   npm install
   # or
   yarn install

3. Set Up Environment Variables: Create a .env file in the project root and add the following:

   MAPBOX_API_KEY=your_mapbox_api_key
   SUPABASE_URL=your_supabase_project_url
   SUPABASE_KEY=your_supabase_public_key
   

4. Run the Development Server:

   npm run dev
   # or
   yarn dev

5. Open your browser and navigate to http://localhost:3000.

Configuring Mapbox

• Obtain a Mapbox API key from Mapbox.
• Ensure the key is added to your .env file as MAPBOX_API_KEY.
• Configure Mapbox in your Nuxt project (e.g., in a plugin or component).

Configuring Supabase

• Create a Supabase project and note the project URL and public key.
• Add these to your .env file as SUPABASE_URL and SUPABASE_KEY.
• Set up the necessary database tables for storing location data (schema details to be added).

Contributing

We welcome contributions from the community! To contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature).
3. Make your changes and commit (git commit -m "Add your feature").
4. Push to the branch (git push origin feature/your-feature).
5. Open a Pull Request.

Please ensure your code follows the project's coding standards and includes appropriate tests.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or feedback, reach out to the Code for Norway team via GitHub Issues or contact us at [[email protected]].

---

Built with ❤️ by Code for Norway