ishgervais / clean-tech-assessment

Newzz (Clean-tech-assessment)

This is a monorepo containing a Laravel server and a React client, configured with Docker and PostgreSQL.

Screenshots

Prerequisites

Before getting started, make sure you have the following tools installed on your system:

• Docker
• Docker Compose

Getting Started

Follow the steps below to run the application:

1. Clone the repository:

   git clone https://github.com/ishgervais/clean-tech-assessment.git

2. Navigate to the root root

   cd your-repo
   

Laravel server

1. Navigate the server

   cd server
   composer install

2. Generate an application key

   php artisan key:generate

3. Start the server

   php artisan serve
   

4. Access the server

   Access the React client at http://localhost:8000.
   

React client (vite)

1. Navigate and install dependencies

   cd client
   pnpm install

2. Start the server

   pnpm run dev
   

3. Access the app

   Access the React client at http://localhost:3000.
   
   

Docker compose

1. Navigate to the project root:

   cd clean-tech-assessment

2. Start the Docker containers

   docker-compose up -d
   

Docker Compose Configuration

The docker-compose.yml file defines the services and their configurations for the application. It includes:

A PostgreSQL database service for the Laravel server.

Environment variables for the PostgreSQL service. Laravel Server The Laravel server is located in the server directory. It comes with a Dockerfile for containerization.

Dockerfile

The Dockerfile for the Laravel server is included in the server directory. It sets up the necessary dependencies and exposes port 8000.

React Client (Vite)

The React client is located in the client directory. It comes with a Dockerfile for containerization.

Dockerfile

The Dockerfile for the React client is included in the client directory. It installs dependencies and builds the React application, exposing port 3000.

PostgreSQL Database

The PostgreSQL database is set up as a service using Docker Compose. It is pre-configured with default credentials and accessible on port 5432.