Skip to content

AquaPod is an innovative project designed to address marine pollution by autonomously collecting waste from the sea. This repository contains the code for the frontend webpage of AquaPod.

Notifications You must be signed in to change notification settings

azuzic/aquapod-frontend

Repository files navigation

AquaPod Frontend

Aquapod Logo

AquaPod is an innovative project designed to address marine pollution by autonomously collecting waste from the sea. This repository contains the code for the frontend webpage of AquaPod.

Getting Started

To run the site locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/your-username/aquapod-frontend.git
  2. Navigate to the project directory:

    cd aquapod-frontend
  3. Install the dependencies:

    npm install
  4. Run the development server:

    npm run dev

    Alternatively, if you need to specify a host:

    npm run dev -- --host
  5. Open your web browser and visit localhost to see the AquaPod frontend in action.

Environment Variables

The following environment variable in .env file needs to be set:

  • VITE_MAPBOX_KEY: This variable should be set to your Mapbox API key. You can obtain a key from the Mapbox website.

And should look like:

VITE_MAPBOX_KEY = "enter_key_here"

Please make sure to set the environment variable before running the development server.

Additional Dependencies

The AquaPod frontend uses the following additional dependencies:

  • Chart.js Used for creating charts and visualizations.
  • Mapbox GL Used for displaying maps and integrating with Mapbox.
  • Pinia A Vue 3 store library for managing application state.
  • Tailwind CSS A utility-first CSS framework used for styling the frontend.

Make sure to install these dependencies by running npm install before starting the development server.

Contributing

If you would like to contribute to AquaPod, feel free to open issues and submit pull requests. We welcome contributions from the community!

License

The AquaPod frontend is released under the MIT License.

About

AquaPod is an innovative project designed to address marine pollution by autonomously collecting waste from the sea. This repository contains the code for the frontend webpage of AquaPod.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published