- 📖 Introduction
- ✨ Features
- 💻 Technologies Used
- ⚙️ Installation
- 🔄 Making a Pull Request
- 🚀 Usage
- 📜 License
- 📞 Contact
- 📂 Project Structure
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.
- 🏠 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.
- Frontend: React, Tailwind CSS
- Backend: Node.js, Express.js
- Database: MongoDB
- Version Control: Git
- Deployment: Heroku
- Clone the repository:
git clone https://github.com/<your-github-username>/school-website.git
-
Navigate to the
client
directory:cd school-website/client
-
Install dependencies:
npm install
-
Set up environment variables: Create a
.env
file in theclient
directory and add the following:REACT_APP_API_URL=http://localhost:5000
-
Run the frontend application:
npm run dev
-
Access the frontend: Open your browser and go to
http://localhost:3000
-
Navigate to the
server
directory:cd school-website/server
-
Install dependencies:
npm install
-
Set up environment variables: Create a
.env
file in theserver
directory and add the following:MONGODB_URI=your-mongodb-uri PORT=5000
-
Run the backend application:
npm start
-
Fork the repository by clicking on the fork symbol at the top right corner.
-
Clone your forked repository:
git clone https://github.com/<your-github-username>/school-website.git
-
Navigate to the project directory:
cd school-website
-
Set the upstream remote:
git remote add upstream https://github.com/Artsy-Technologies/school-website
-
Create a new branch:
git checkout -b YourBranchName
or
git branch YourBranchName
git switch YourBranchName
-
Sync your fork with the upstream repository:
git fetch upstream git merge upstream/main
-
Make your changes to the source code.
-
Stage your changes and commit:
git add file/folder git commit -m "<your_commit_message>"
-
Push your changes to your forked repository:
git push origin YourBranchName
-
Create a pull request on GitHub.
Congratulations on your contribution! 🙌🏼
- 🔐 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.
For any questions or suggestions, please contact:
- 📧 Email: theartsytechnology@gmail.com
- 🐙 GitHub: Artsy-Technologies
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!