Skip to content

CentricEU/Local4Local

Repository files navigation

🌍 Local4LocalEU Project

Welcome to the Local4LocalEU project! This README provides all the necessary instructions to set up and run the application on your local machine.

The project is composed of:

  • Frontend: Angular
  • Backend: Spring Boot
  • Database: PostgreSQL

🚀 Prerequisites

Before starting, ensure you have the following installed on your machine:


🛠️ Project Setup

1️⃣ Clone the Repository

  1. Select the development branch.

  2. Run the following commands:

    git clone https://github.com/CentricEU/Local4Local.git
    cd Local4Local

2️⃣ Backend Setup (Spring Boot)

Step 1: Configure the Database

  1. Ensure PostgreSQL is running.

  2. Create a new database in PostgreSQL, e.g., local4localEU.

  3. Update your PostgreSQL credentials in the application.properties or application.yml file located in backend/src/main/resources/:

    spring.datasource.url=jdbc:postgresql://localhost:5432/local4localEU
    spring.datasource.username=your_username
    spring.datasource.password=your_password
  4. Set Up the .aws Folder

    a. Install AWS CLI if you haven't already:

    b. Configure the AWS CLI: - Run the following command in your terminal to configure the AWS CLI with your credentials:

     aws configure
    • During configuration, you will be prompted to enter your:
    • AWS Access Key ID
    • AWS Secret Access Key
    • Default region name (e.g., us-east-1)
    • Default output format (e.g., json)

    c. The .aws folder will be created in your user directory, typically at C:/Users/your_username/.aws on Windows, or ~/.aws on macOS/Linux.

    d. Ensure that your AWS credentials are properly configured by checking the folder and files at:

    • C:/Users/your_username/.aws/credentials
    • C:/Users/your_username/.aws/config

Step 2: Build and Run the Backend

  1. Open the backend folder in your IDE.
  2. Build and run the Spring Boot project.
  3. The backend service will now be running at http://localhost:8080.

3️⃣ Frontend Setup (Angular)

Step 1: Navigate to the Frontend Directory

cd frontend

Step 2: Install Dependencies

npm install

📋 Note: If you encounter issues with dependency conflicts, try running:

npm install --legacy-peer-deps

Step 3: Run the Frontend Application

npm start

🌐 Running the Application

  1. Ensure that both the backend and frontend servers are running.
  2. Open your browser and navigate to http://localhost:4200.
  3. The frontend should now be connected to the backend and ready to use.

🐞 Troubleshooting

Backend Issues

  • Database Connection Error: Ensure PostgreSQL is running and the credentials in application.properties are correct.
  • Port Conflicts: Verify that port 8080 is free or update the port in application.properties.

Frontend Issues

  • Dependency Errors: Run npm install to ensure all dependencies are installed.
  • Port Conflicts: Verify that port 4200 is free or update the Angular CLI configuration.

🌟 Thank you for using Local4LocalEU!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5