CostaCompas is a project developed during the Hackathon HackUDC in A Coruña. It consists of a website that recommends the best beach for the user based on the activity they want to do. The available activities are sunbathing ☀️, playing volleyball ⚽, swimming 🏊, running 🏃, and windsurfing 🏄. The user can select the day (today, tomorrow, or the day after tomorrow) and the time they want to go to the beach. In addition, the user must select the location from which they want to go to the beach or let the system know their current location.
Once the user has selected the day, the activity, and the location, the system obtains the 20 closest beaches and ranks them based on the weather conditions (wind, temperature, and cloud area fraction) and the activity the user wants to do. We obtain weather conditions using MeteoSIX's API, provided by MeteoGalicia.
Once the ranking is done, the system shows the 5 best beaches, indicating the temperature, wind, distance, and driving time, and shows a map with the driving route to each of the 5 best beaches.
First of all, to run the backend you need to create a file called secrets.json including an API Key of MeteoSIX. You can request one on the MeteoSIX's API web site.
The file secrets.json must be like this:
{
"API_KEY_METEO": "YOUR_API_KEY"
}
To run the backend on Linux it could be helpfull use virtual environments:
python -m venv myvenv
source myvenv/bin/activate
pip install -r requirements.txt
export FLASK_APP="app.py"
flask run
Also, you can add last two commands at the end of myvenv/bin/activate to run flask automatically when venv is activated.
To run the backend on Windows using virtual environments:
python -m venv myvenv
./myvenv/Scripts/Activate.ps1
pip install -r requirements.txt
Once the venv is created, you can modify Activate.ps1 to run flask automatically adding the following lines, or directly run them in terminal:
$env:FLASK_APP = "app.py"
flask --debug run
Once the backend is deployed, you can see it on localhost:5000.
To run the frontend, you should use Node.js (version 16.x) and npm:
npm install
npm run dev
Then, the frontend will be running on localhost:5137.
Note: You have to change URL_BACKEND in file package.json to http://localhost:5000. Otherwise, the frontend will connect to the backend deployed on https://costacompas-backend.onrender.com.
Alternatively, you can use Docker Compose to run the backend and the frontend in two Docker containers. First of all, you may change URL_BACKEND in file package.json to http://backend:5000. Then, you have to run:
docker compose up -d
When the containers are running, the frontend will be running inside one of the containers on port 5137, and the backend on the other container on port 5000. Those ports are redirected to same ports on the host machine, so you will be able to see the frontend on localhost:5137, and the backend on localhost:5000.
CostaCompas is under the MIT license. Please see the LICENSE file for more information.