Social Network App

Welcome to the Social Network App repository! This project was created as a way to put into practice my knowledge of Java for web development. Whether you're a developer, contributor, or user, this file will provide you with all the necessary information to get started.

Table of Contents

• Project Overview
• Features
• Installation
• Usage
• Contributing
• Support
• License

Project Overview

Social Network App is a simple yet powerful application designed to connect people and facilitate communication. It leverages Java, Spring Boot, MySQL, Thymeleaf and Bootstrap to provide users with a platform to share their thoughts and ideas with others. My aim is to create a welcoming and inclusive community where users can interact and engage with each other.

Features

• User registration and login: Users can create an account and log in to access the app's features.
• Posting text-based content: Users can create posts to share their thoughts and ideas with others.
• Viewing a feed of posts: Users can view a feed of posts from users they follow.
• Following/unfollowing other users: Users can follow or unfollow other users to customize their feed.
• Liking posts: Users can like posts to show their appreciation for the content.

Installation

To set up the project on your local machine, please follow these steps:

1. Clone this repository to your local machine.

git clone https://github.com/erickgnclvs/socialnetwork.git

2. Install MySQL on your computer.
3. Open the cloned repository in your preferred IDE or text editor.
4. Create a new MySQL database for the app.
5. Update the application.properties file with your database connection information.
6. Run the app using the ./mvnw spring-boot:run command.

Congratulations! The project is now installed and running on your local machine.

Usage

Here are some instructions on how to use the Social Network App:

1. Access the app through the provided URL or by visiting http://localhost:8080 in your web browser.
2. Create an account by clicking on the "Register" button and filling out the registration form.
3. Log in to your account by clicking on the "Login" button and entering your credentials.
4. Explore the different sections of the app, such as creating posts, viewing your feed, following/unfollowing other users, and liking posts.

For more detailed instructions, please refer to our User Guide.

Contributing

We appreciate contributions from the community to enhance our project. To contribute, please follow these guidelines:

1. Fork this repository to your GitHub account.
2. Create a new branch for your feature or bug fix:

git checkout -b feature/your-feature

3. Make your changes and ensure they are properly tested.
4. Commit your changes with descriptive commit messages:

git commit -m "Add your commit message here"

5. Push your branch to your forked repository:

git push origin feature/your-feature

6. Open a pull request in this repository, describing the changes you made and why they should be merged.

Thank you for contributing to our project!

Support

If you encounter any issues or have any questions or suggestions regarding our project, please feel free to reach out. You can contact me through my e-mail or by opening an issue in this repository.

License

This project is licensed under the MIT License.