Skip to content

Vaibhav2154/school-website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 

Repository files navigation


🏫 School Website

GitHub stars GitHub forks GitHub issues GitHub license

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.

💻 Technologies Used

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

⚙️ Installation

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. Set up environment variables: Create a .env file in the client directory and add the following:

    REACT_APP_API_URL=http://localhost:5000
    
  4. Run the frontend application:

    npm run dev
    
  5. Access the frontend: Open your browser and go to 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_URI=your-mongodb-uri
    PORT=5000
    
  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! 🙌🏼

🚀 Usage

  • 🔐 Admin Panel: Admins can log in to manage website content, such as updating news, events, and faculty profiles.
  • 🖥️ User Interaction: Students and parents can browse the website to get information, view the gallery, and contact the school.

📞 Contact

For any questions or suggestions, please contact:

📂 Project Structure

school-website/
├── client/
│   ├── public/
│   ├── src/
│   │   ├── assets/
│   │   │   └── react.svg
│   │   ├── components/
│   │   │   ├── Carousel/
│   │   │   │   ├── Carousel.jsx
│   │   │   │   └── Data.js
│   │   │   ├── Layout/
│   │   │   │   └── MainLayout.jsx
│   │   │   ├── faq/
│   │   │   │   ├── Faq.jsx
│   │   │   │   └── FaqSection.jsx
│   │   │   ├── footer/
│   │   │   │   └── Footer.jsx
│   │   │   ├── header/
│   │   │   │   └── Navbar.jsx
│   │   │   ├── table/
│   │   │   │   └── Table.jsx
│   │   ├── pages/
│   │   │   ├── AboutPage.jsx
│   │   │   ├── AcademicsPage.jsx
│   │   │   ├── AdmissionPage.jsx
│   │   │   ├── ContactPage.jsx
│   │   │   ├── HomePage.jsx
│   │   │   └── StudentPage.jsx
│   ├── .eslintc.cjs
│   ├── .gitignore
│   ├── README.md
│   ├── index.html
│   ├── package-lock.json
│   ├── package.json
│   ├── postcss.config.js
│   ├── tailwind.config.js
│   └── vite.config.js
└── server/
    ├── controllers/
    │   └── adminController.js
    ├── libs/
    │   └── databaseConnection.js
    ├── routes/
    │   └── adminRouter.js
    ├── .env
    ├── .gitignore
    ├── index.js
    ├── package-lock.json
    ├── package.json
LICENSE
README.md

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