Skip to content

Latest commit

 

History

History
204 lines (146 loc) · 7.65 KB

README.md

File metadata and controls

204 lines (146 loc) · 7.65 KB
Raw

Contributors Closed Pull Requests Stargazers Issues MIT License


SE10 Logo

SE10 NETWORK FRONTEND

Welcome to the SE10 NETWORK frontend repository! This frontend application serves as the user interface for a social media platform specifically designed for students of IJSE (Institute of Software Engineering). It enables students to create and share posts, view updates from others, and receive notifications about important events like birthdays and campus-related activities.
Explore the project »

View Design · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. API Documentation
  4. Figma Design
  5. Backend Repository
  6. Top contributors
  7. License

About The Project

Desktop - 1

User Interface:

  • Clean and responsive interface built with HTML, CSS, and Bootstrap.
  • Dynamic elements for user interaction powered by JavaScript and JQuary.

Post Management:

  • Users can create, view, and delete posts.
  • Live updates of posts for a seamless user experience.

Notifications:

  • Birthday reminders and event notifications.
  • Visual indicators for new updates.

Axios Integration:

  • Used for communicating with the backend API to handle requests and responses.

(back to top)

Built With

This project was developed using a variety of modern web technologies and libraries to ensure a responsive and dynamic user experience.

  • HTML
  • CSS
  • JavaScript
  • JQuery
  • Axios
  • Bootstrap

(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 setting up the project, make sure you have the following tools and libraries installed or configured as needed:

  • Axios
    Axios is already included in the project. No additional installation is required.

  • Bootstrap
    Bootstrap has already been downloaded and set up for the project.

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-FRONTEND.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.

Figma Design

Check out the Figma design for the frontend here.

Backend Repository

Access the backend repository on GitHub here.

(back to top)

Top contributors:

contrib.rocks image

(back to top)

License

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

(back to top)

© 2024 SE10 NETWORK