KLV Project

KLV Project is a full-stack web application developed as a study project. It serves as a news aggregator, combining a React frontend, a Spring Boot backend, and a MySQL database to provide users with a seamless news browsing experience.

Features

• Browse and read news articles from various sources.
• User registration and login functionality.
• Bookmark articles for future reference.
• User profile page to manage bookmarks.
• Integration with external APIs to fetch news data.

Technologies Used

Frontend: React, HTML5, CSS3, JavaScript
Backend: Spring Boot (Java)
Database: MySQL
Docker: Containerization and deployment
HTTP Client: Axios
Version Control: Git
IDE: IntelliJ IDEA (Java), Visual Studio Code (React)

Getting Started

To get started with the KLV Project, follow these steps:

1. Clone the repository to your local machine.
2. Make sure you have Docker installed.
3. Update the environment variables in the .env file with your desired configuration.
4. Build and run the Docker containers using the docker-compose up command in the root directory.
5. Access the application in your browser at http://localhost:3001.

Folder Structure

The project has the following folder structure:

• react-ui: Contains the React frontend code.
• springboot-backend: Contains the Spring Boot backend code.
• mysql-database: Contains the MySQL database configuration.

Development Workflow

1. Make changes to the code in the respective folders.
2. Run the application locally using the provided scripts or commands.
3. Test your changes and verify that the application is functioning as expected.
4. Commit your changes to a new branch and push them to the remote repository.
5. Create a pull request for review and merge it into the main branch.

Contributing

Contributions to the KLV Project are welcome! This project is designed for study purposes, so if you find any bugs, issues, or have any suggestions, please open an issue or submit a pull request

License

This project is licensed under the MIT License.

Acknowledgements

The KLV Project team would like to thank all the contributors for their hard work and dedication.

Contact

For any inquiries or questions, please contact the project team at [email protected].