Hello everybody, welcome to my Dockerized Lara React Project

This repository serves as a starting point for setting up a Dockerized environment for a Laravel, MySQL, and React project.

1. First of all you need to clone this repository to your local machine:

git clone https://github.com/AhsanDev21/news-aggregator-app.git

Please install these tools below:

• Docker Engine 22.0.0 or later
• Docker Compose 2.0.0 or later

Getting Started

1. Go to the project directory:

cd ahsan-innoscripta-app

2. Now Build and start the Docker containers:

docker-compose up -d

3. Now you need to install following commands for React.

cd frontend
npm install
cd ../
docker-compose up --build -d

This command will start the following Docker containers:

backend: the Laravel application server running on port 8000

mariadb: the MySQL database server running on port 3306

frontend: the React development server running on port 8080

5. Migrate the database:

• Run the following command to connect to the laravel-app container:

docker-compose exec backend sh

Then, run the following command to migrate the database:

php artisan migrate

6. To update news automatically in every hour, execute below command

php artisan insert-news

6. Access the Laravel backend application:

• Open your web browser and go to http://localhost:8000. You should see the Laravel welcome page.

• If the php artisan insert-news command doesn't work in your local machine then execute http://127.0.0.1:8000/insert-news from your browser URL. It will insert the news to database from 3 different API and redirect to http://localhost:8080 (frontend) user login page.

7. Access the React frontend application:

• Open your web browser and go to http://localhost:8080. You should see the React application.

Stopping the Containers

To stop the Docker containers, press Ctrl+C in the terminal window where you started the containers. Alternatively, you can run the following command in the project directory:

docker-compose down

This command will stop and remove the containers, as well as the network and volumes created by-

docker-compose up

Application user manual

1. After successfully running both backend and frontend you will get a user login panel.

2. Since you have no user account, at first click register button to make a user account.

3. After successfully creating account you'll be redirected to home page. On the right top menu bar you can see your name and logout icon.

4. User can search or sort news from the search bar and right side date picker and dropdown options.

5. If you click on the name you'll be redirected to User Dashboard and you can customize your news feed interest from there.

6. If you click on logout you'll be logged out and redirected to login panel.

 

Best Regards Ahsan Khan.