SE10 NETWORK BACKEND

Welcome to the SE10 NETWORK backend repository! This backend service powers a social media platform built specifically for students of IJSE (Institute of Software Engineering). The platform allows students to interact by creating and sharing posts, viewing posts by others, and receiving personalized notifications for special events like birthdays and campus-related events.
Explore the project »

· Report Bug · Request Feature .

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. API Documentation
4. Frontend Repository
5. Top contributors
6. License

About The Project

• User Registration and Login: Users can register and log into the platform.
• Post Management:
  • Users can create new posts to share their thoughts or updates with fellow students.
  • Users can view posts created by others, fostering social interaction.
  • Users can delete their own posts when needed.
  • Users can react posts.
• Notifications:
  • Users will be notified about upcoming events relevant to their academic life.
  • Birthday notifications to remind users of their fellow students' birthdays.

(back to top)

Built With

This project was developed using a range of modern backend technologies and frameworks to ensure robust performance, scalability, and secure data handling.

(back to top)

Getting Started

Follow these steps to set up the project locally and get it running on your machine. The instructions will guide you through the process of cloning the repository, installing dependencies, and configuring any required settings.

Prerequisites

Before you begin, ensure you have the following installed on your system:

• Java 17 or higher: Ensure you have JDK installed and configured on your system to compile and run application.
• MySQL: Ensure you have MySQL installed and running locally or remotely.
• Maven: Used for dependency management and building the project.
• Postman or any API client to test the API (optional, but recommended).

Installation

Follow these steps to install and set up the project on your local machine:

1. Clone the repository

   git clone https://github.com/SE10-IJSE/SE10-NETWORK-BACKEND.git

2. Change git remote url to avoid accidental pushes to base project

   git remote set-url origin github_username/repo_name
   git remote -v # confirm the changes

(back to top)

API Documentation

Refer to the Postman API Documentation for detailed API endpoints and usage instructions.

Frontend Repository

Access the frontend repository on GitHub here.

(back to top)

Top contributors:

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

© 2024 SE10 NETWORK