Check out the Live Demo of the project.
- 📖 Introduction
- ✨ Features
- 💻 Technologies Used
- ⚙️ Installation
- 🔄 Making a Pull Request
- 📜 License
- 📞 Contact
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.
- ✨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.
- Frontend: React, Tailwind CSS
- Backend: Node.js, Express.js
- Database: MongoDB
- Version Control: Git
- Deployment: Render
- 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
-
Run the frontend application:
npm run dev
-
You can view the website in localhost:
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_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>
-
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! 🙌🏼
For any questions or suggestions, please contact:
- 📧 Email: [email protected]
- 🐙 GitHub: Artsy-Technologies
Show some ❤️ by giving a ⭐️ to this repo!