Skip to content

jikrana1/School_Website

Β 
Β 

Repository files navigation

πŸ› οΈ Tech Stack

Frontend

HTML5 CSS3 JavaScript React

Backend & Database

NodeJS Express.js MongoDB

✨ Key Features

  • πŸ“‹ Real-Time Notice Board: Instantly broadcast important announcements, updates, and events across the portal to keep students and faculty aligned.
  • πŸ“š Resource Sharing: A centralized hub for uploading, downloading, and organizing study materials, assignments, and lecture notes.
  • πŸ€– AI Assistant: An integrated intelligent chatbot to help users navigate the portal, answer frequent queries, and provide instant support.

πŸ“ Project Structure

edustream/
β”œβ”€β”€ backend/                # Server-side logic, APIs, and database models
β”‚   β”œβ”€β”€ config/             # Database connection and environment configurations
β”‚   └── routes/             # API route definitions
β”œβ”€β”€ frontend/               # Client-side React application
β”‚   β”œβ”€β”€ public/             # Static assets
β”‚   └── src/                # React components and pages
β”œβ”€β”€ config/                 # Global repository configuration files
└── README.md               # Project documentation

# πŸŽ“ EduStream Academy Portal

EduStream is a comprehensive Full-Stack Academic Management Portal designed to bridge the gap between students, faculty, and administration.Built with the MERN stack (MongoDB, Express, React, Node.js), it features real-time notice boards, academic resource sharing, and an AI-integrated support system for student inquiries.

---

## πŸš€ Features

### πŸ“’ Real-Time Notice Board

* Dynamic announcements fetched from the MongoDB database.
* Instant updates for students and faculty.

### πŸ“š Academic Resource Hub

* Centralized repository for course materials and STEM excellence programs.
* Easy access to academic resources.

### πŸ€– AI Support Integration

* Powered by the Gemini API.
* Handles admission and academic queries instantly.

### 🏫 Infinite Campus Gallery

* High-performance CSS-animated marquee.
* Showcases campus life and activities.

### 🎨 Professional UI

* Fully responsive design.
* Built with Tailwind CSS and Lucide React Icons.

---

## πŸ› οΈ Tech Stack

### Frontend

* React.js
* Vite
* Tailwind CSS
* Axios

### Backend

* Node.js
* Express.js

### Database

* MongoDB

### AI Integration

* Gemini API

---

## πŸ“‚ Project Structure

```bash
SCHOOL_WEBSITE/
β”‚
β”œβ”€β”€ backend/                 # Node.js & Express Server
β”‚   β”œβ”€β”€ config/              # MongoDB Connection Logic
β”‚   β”œβ”€β”€ controllers/         # Business Logic
β”‚   β”œβ”€β”€ routes/              # API Endpoints
β”‚   └── server.js            # Entry Point
β”‚
β”œβ”€β”€ frontend/                # React & Vite Application
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ api/             # Axios Configurations
β”‚   β”‚   β”œβ”€β”€ components/      # Reusable UI Components
β”‚   β”‚   └── data/            # Static Data & State Management
β”‚
└── .env                     # Environment Variables

βš™οΈ Setup & Installation

Prerequisites

Make sure you have the following installed:

  • Node.js (v18+)
  • MongoDB
  • npm (Node Package Manager)

1️⃣ Clone the Repository

git clone https://github.com/Sitaram8472/School_Website.git
cd School_Website

2️⃣ Backend Setup

Navigate to the backend folder:

cd backend

Install dependencies:

npm install

Create a .env file inside the backend directory and add the required environment variables:

MONGODB_URI=your_mongodb_connection_string
PORT=5000
GEMINI_API_KEY=your_gemini_api_key

Start the backend server:

npm run dev

3️⃣ Frontend Setup

Navigate to the frontend folder:

cd ../frontend

Install dependencies:

npm install

Start the React application:

npm run dev

🀝 Contribution Guide

We welcome contributions from the community!

Steps to Contribute

  1. Fork the repository.
  2. Create a feature branch:
git checkout -b feature/AmazingFeature
  1. Commit your changes:
git commit -m "Add AmazingFeature"
  1. Push to your branch:
git push origin feature/AmazingFeature
  1. Open a Pull Request.

🌟 Support

If you find this project useful, don't forget to give it a ⭐ on GitHub.

Happy Coding! πŸš€

About

EduStream is a modern school portal that brings students, teachers, and parents together. It features a real-time notice board, easy resource sharing, and a helpful AI assistant for student questions. Designed for simplicity, EduStream helps our entire school community stay connected, organized, and supported every single day.

Resources

License

Code of conduct

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 98.5%
  • CSS 1.4%
  • Other 0.1%