codecoolglobal/solar-watch-security-java-soosdsara

Solar Watch

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Steps with Docker
   • Steps withot Docke
3. Usage
4. Roadmap

About The Project

It is a small application that simply shows the time of sunrise and sunset by entering a date and city, using two external APIs.

[]

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

With Docker

• Git
• Docker
• Docker Compose

Without Docker

• Git
• Node.js
• Java Development Kit (JDK)
• Maven
• Postgresql

Installation

1. Clone the repo

git clone https://github.com/your_username_/Project-Name.git
cd Project-Name

2. Create a new PostgreSQL database in terminal or with pgAdmin4.

3. Copy the .env.sample as .env and set the following environment variables:

JWT_SECRET=your_jwt_secret_key
DATABASE_USERNAME=your_database_username
DATABASE_PASSWORD=your_database_password

With Docker

4. Set the following environment variables in the .env file:

DATABASE_URL=jdbc:postgresql://solarwatch-database:5432/solarwatch
BACKEND_URL=http://backend:8080

5. Run the Docker and the following command to start all necessary services:

docker-compose up

Backend availability: http://localhost:8080

Frontend availability: http://localhost:3000

Without Docker

Backend:

4. Set the following environment variables in the .env file:

DATABASE_URL=jdbc:postgresql://localhost:5432/your_database
BACKEND_URL=http://localhost:8080

5. Navigate to the backend library:

   cd backend
   

6. Download dependencies:

   ./mvnw clean install
   

7. Start the application:

   ./mvnw spring-boot:run
   

Backend availability: http://localhost:8080

Frontend:

4. Open a new terminal window and navigate to the frontend directory:

cd frontend

5. Install dependencies:

npm install

6. Start the application:

npm run dev

Frontend availability: http://localhost:5173

(back to top)

Usage

Simply select a date, enter a city name, and the two times will appear.

[]

(back to top)

Roadmap

• Add UI message
• Add Loading page
• Add unique username Verification
• Add password Verification
• Create Admin page

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

(back to top)