Skip to content

marcguillemdev/aemet-marc-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AEMET Spring Boot Application

Application developed with Spring Boot 3.3.2 that serves forecast information through a REST API.

🛠️ Setup development environment

This project uses DevContainers to build all the dependencies and programs needed to run it. If you've never heard of them, here's some more information.

Before you can open and run the DevContainer, you need to have cloned the repository into a Linux environment, such as Ubuntu. If you are not in Linux, follow the Windows steps.

🪟 Windows environment

You will need to install WSL2 (with Ubuntu) and Docker Desktop and then link Ubuntu with Docker Desktop.

Once you have the above set up, you have to link Docker Desktop with your downloaded Ubuntu distro running in WSL:

  1. Open Docker Desktop --> Settings --> Resources --> WSL Integration.
  2. Select your Ubuntu distro.

📃 Running Visual Studio Code

For everything to start properly, we have to open Visual Studio Code and download the VSCode Remote Development to be able to connect to our distro in WSL. To connect:

  1. Open the command palette and type 'Connect to WSL distro...'
  2. Select our Ubuntu distro.

🐧 Linux environment

If you are on Linux (Ubuntu), the only thing you need to have installed is Docker.

💾 Cloning the repository

It is important to note that the repository clone has to be done once we have connected to the WSL (if you are on Windows) from our VSCode.

Once we have done so, we can run the command in a new terminal INSIDE VSCode:

git clone https://github.com/marcguillemdev/aemet-marc-backend

🔧 Setup .env file

The project uses environment variables to manage the most sensitive properties. The .env file must be located in .devcontainer.

The following properties has to be present:

  • MONGO_INITDB_ROOT_USERNAME=root
  • MONGO_INITDB_ROOT_PASSWORD=password
  • AEMET_API_KEY=your_aemet_api_key

🎉 Running DevContainer

Once we have the .env file created, we can run the DevContainer:

  1. Open the command palette and type 'Reopen in container...' or 'Open folder in container...'
  2. Wait for the container to load
  3. Find the Spring Boot icon in the left sidebar and execute your project

🐋 DockerHub

The package is available through DockerHub.

💼 LICENSE

GNU General Public License v3.0

About

Application developed with Spring Boot 3.3.2 that serves forecast information through a REST API.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages