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.
To run the site locally, follow these steps:
-
Clone the repository:
git clone https://github.com/your-username/aquapod-frontend.git
-
Navigate to the project directory:
cd aquapod-frontend
-
Install the dependencies:
npm install
-
Run the development server:
npm run dev
Alternatively, if you need to specify a host:
npm run dev -- --host
-
Open your web browser and visit
localhost
to see the AquaPod frontend in action.
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.
The AquaPod frontend uses the following additional dependencies:
- Used for creating charts and visualizations.
- Used for displaying maps and integrating with Mapbox.
- A Vue 3 store library for managing application state.
- 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.
If you would like to contribute to AquaPod, feel free to open issues and submit pull requests. We welcome contributions from the community!