---
sidebar_position: 1
sidebar_label: Intro
---

import DocBanner from '@site/src/components/DocBanner/DocBanner';

<DocBanner />
# Student Web Portal

Welcome to the Student Web Portal documentation. This section covers the setup, installation, and deployment of the eSchool SaaS Student Web Portal.

## Overview

The Student Web Portal is a web-based interface designed for students to access their academic information, assignments, attendance, exams, and more.

## What's Covered

This documentation includes:

- **File Structure**: Understanding the project organization
- **Installation**: Step-by-step setup guide
- **Firebase Setup**: Configuring push notifications in `public/firebase-messaging-sw.js` and `.env.local`
- **Deployment**: How to deploy the Student Web Portal

## Key Features

- Student dashboard
- View class schedules and timetables
- Access assignments and homework
- Check attendance records
- View exam results
- Download study materials
- Communication with teachers
- Fee payment information
- Real-time push notifications

## Prerequisites

Before you begin, ensure you have:

### Node.js (version 18 or higher)

Node.js is required to run the Student Web Portal. Download and install it from the official website:

**Official Download:** [https://nodejs.org/](https://nodejs.org/)

#### Installation Instructions:

**For Windows:**

1. Visit [https://nodejs.org/](https://nodejs.org/)
2. Download the Windows Installer (.msi) - choose LTS (Long Term Support) version
3. Run the installer and follow the installation wizard
4. Accept the license agreement
5. Choose the installation path (default is recommended)
6. Click "Install" and wait for completion
7. Verify installation by opening Command Prompt and typing:
   ```bash
   node --version
   npm --version
   ```

**For macOS:**

1. Visit [https://nodejs.org/](https://nodejs.org/)
2. Download the macOS Installer (.pkg) - choose LTS (Long Term Support) version
3. Run the installer and follow the installation wizard
4. Click "Continue" through the prompts and agree to the license
5. Click "Install" and enter your password if prompted
6. Verify installation by opening Terminal and typing:
   ```bash
   node --version
   npm --version
   ```

**Alternative for macOS (using Homebrew):**

If you have Homebrew installed, you can install Node.js via Terminal:

```bash
brew install node
```

### Other Requirements:

- npm or yarn package manager (included with Node.js)
- Firebase Project: Update credentials in `public/firebase-messaging-sw.js` and `.env.local`
- Admin Panel API running
- Basic knowledge of web development

## Next Steps

Navigate through the documentation using the sidebar to learn about installation and deployment.