Solar Watch

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Acknowledgments

About The Project

Solar Watch is a full-stack weather web application where registered users can retrieve sunrise and sunset times for any city on any date. The app uses an integrated PostgreSQL database to store every requested city and solar event time to reduce external API calls, increasing performance. If the requested data is not yet available in the database, only then does the app retrieve it from external APIs.

Built With

• Frontend

  

• Backend

  

• Database

  

• Containerization

  

(back to top)

Getting Started

Prerequisites

• Docker installed
• An OpenWeather API key is required. You can sign up here for free.

Installation

• Please note: The app is not in a working condition yet, so the installation steps are missing for now.

• You can clone the repository to look at the code in the meantime:

  git clone https://github.com/CodecoolGlobal/solar-watch-MVP-java-Davidjuhasz05.git
  cd solar-watch-MVP-java-Davidjuhasz05

(back to top)

Roadmap

• Build the Backend
  • Add Database Connection
  • Dockerize Backend
  • Implement Token-Based User Auth. with Spring Security (Login, Signup)
  • Add Admin Role and CRUD Functionality
• Build the Frontend
  • Create Necessary Pages (Login/Signup, Home, Results)
  • Connect to Backend
  • Create CSS
  • Dockerize Frontend
• Create Tests (Unit, Integration)
• Add CI/CD pipeline
• Expand with New Features

See the open issues for a full list of proposed features (and known issues).

(back to top)

Acknowledgments

• OpenWeatherMap API for converting city names into geographical coordinates
• Sunrise-Sunset API for the sunrise/sunset times

(back to top)