patel-school: A JavaScript repository from sudhanshutech

Introduction

A react based school website as an open source. Multilple functionality are embedded in the web application where students can get all the information related to the school knowing from courses to registration and results.

✅ Live: www.patelvidhyalaya.com

Features

Couses Information
Secure Login functionality
Student Registration
Student details saved at firebase
Student Result (comming soon)
Admin and Student Dashboard
Edit, Delete and Add funtionality of students
Fully responsive with clean UI desing
Payment Gateway (comming soon)

Run Locally

Clone the project

  git clone git@github.com:Yashsharma1911/patel-school.git

Go to the project directory

  cd Patel-School

Install dependencies

  npm install

Start the development server

  npm start

Folder Structure

Environment Variables

To run this project, you will need to add the following .env files in ~/root directory

.env.envName
.env.production
.env.staging

Now you need to put following firebase configuration in these .env files. You can find your firebase configuration bottom of project setting in firebase.

REACT_APP_API_KEY = "Your app API key"
REACT_APP_AUTHDOMAIN =  "Your app auth domain"
REACT_APP_PROJECT_ID =  "Your app project ID"
REACT_APP_MESSAGING_SENDER_ID = "you app messaging-sender ID"
REACT_APP_APP_ID = "Your app ID"
REACT_APP_MESUREMENT_ID = "Your app mesurement ID"
REACT_APP_STORAGEBUCKET = "Your app storagebucket"

Used By

This project is used by the following organisation:

Patel Higher Secondary School

Running Tests

To do Integration testing or End-to-End testing of this website, you will need to have Cypress >=7.2.0 in your project. If you don't already have it, you can get it HERE or you can run following command to install cypress as a project dependency

  npx install cypress

Start testing

Run following command to start tests

npx run cypress

Terms & Conditions

Of course, all of the code is there and nothing is hidden from you so if you would like to make any other styling changes, feel free!
You can not sell this project.