Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.65 KB

README.md

File metadata and controls

31 lines (21 loc) · 1.65 KB

News Aggregator [React + Typescript]

The project was built with React from a foundation created with Vite. You can find the API for this project here

Vite plugins:

Authentication

Authentication was done using JWT token. The package to manage the global authentication state was React Auth Kit

How to run the project

The project is dockerized. To run the project using docker you must have it installed on your computer.

  • Copy and paste the .env file for laravel in the rood folder [This file is not included in the repository].
  • Build the Dockerfile docker build -t react-with-vite .
  • Run the Docker Container docker run -d --rm -p 3001:3001 --name new-aggregator react-with-vite

The port configured to be exposed is 3001. If you need to change it, make sure to modify the vide.config.ts file.

Now you will be able to open the app in your browser. Open the Browser and access http://localhost:3001. Remember that the application expects the server to be running.

Improvements

  • Includes tests using Jest and Express
  • Error handling and notify the user using the notification system already configured in the app.
  • Profile page to allow users to adjust their personal information
  • Use React Helmet to improve the metadata.
  • Create a main menu