Skip to content

Prithwi32/school-website

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


🏫 School Website

GitHub stars GitHub forks GitHub issues GitHub license

Live Demo

Check out the Live Demo of the project.

Table of Contents

📖 Introduction

The School Website project is a web application designed to provide students, teachers, and parents with easy access to school information, resources, and services. The website aims to enhance communication and engagement within the school community.

✨ Features

  • 🏠 Home Page: Overview of the school with news and announcements.
  • 📚 About Us: Information about the school's history, mission, and values.
  • 📖 Academics: Details about the curriculum, subjects, and academic programs.
  • 👥 Student Life: Gallery showcasing school events and student activities.
  • 📧 Contact Us: Contact form and school contact information.
  • Admin Dashboard: A comprehensive control panel for school administrators to add, edit, or delete image Gallery, fee structure, testimonials and manage the Admission and contact forms.

💻 Technologies Used

  • Frontend: React, Tailwind CSS
  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Version Control: Git
  • Deployment: Render

⚙️ Installation For LocalHost Running

Frontend Installation

  1. Clone the repository:
      git clone https://github.com/<your-github-username>/school-website.git
  1. Navigate to the client directory:

     cd school-website/client
    
  2. Install dependencies:

     npm install
    
  3. Run the frontend application:

    npm run dev
    
  4. You can view the website in localhost: http://localhost:3000

Backend Installation

  1. Navigate to the server directory:

    cd school-website/server
    
  2. Install dependencies:

    npm install
    
  3. Set up environment variables: Create a .env file in the server directory and add the following:

    MONGODB_URL = <your-mongodb-uri>
    JWT_SECRET = <jwt secret code>
    EMAIL_ADMIN = <email address for sending notifications>
    EMAIL_PASS = <password for the email account>
    ADMIN_TOKEN = <admin token required to signUp for admin>
    
    
  4. Run the backend application:

    npm start
    

🔄 Making a Pull Request

  1. Fork the repository by clicking on the fork symbol at the top right corner.

  2. Clone your forked repository:

    git clone https://github.com/<your-github-username>/school-website.git
    
  3. Navigate to the project directory:

    cd school-website
    
  4. Set the upstream remote:

     git remote add upstream https://github.com/Artsy-Technologies/school-website
    
  5. Create a new branch:

    git checkout -b YourBranchName
    

or

  git branch YourBranchName
  git switch YourBranchName
  1. Sync your fork with the upstream repository:

     git fetch upstream
     git merge upstream/main
    
  2. Make your changes to the source code.

  3. Stage your changes and commit:

    git add file/folder
    git commit -m "<your_commit_message>"
    
  4. Push your changes to your forked repository:

    git push origin YourBranchName
    
  5. Create a pull request on GitHub.

Congratulations on your contribution! 🙌🏼

📞 Contact

For any questions or suggestions, please contact:


Show some ❤️ by giving a ⭐️ to this repo!


About

An educational website about a school

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 99.5%
  • Other 0.5%