Welcome to the "college-website" project! This document provides instructions for setting up the project, running it in development mode, building for production, and maintaining code quality through linting.
Before you begin, ensure you have the following installed on your development machine:
- Node.js (v14.x or higher) and npm: Node.js Official Website
- Git: Git Official Website
- Code Editor (recommended: VS Code): VS Code Official Website
-
Open your terminal and write these one by one and press enter:
git clone https://github.com/Aburraq/college-website
cd college-website
npm installnpm install react-dom@18.2.0 react-icons@5.2.1 react-scroll@1.9.0
To start the development server and work on the project locally:
npm run dev
We welcome contributions from the community! To contribute, follow these steps:
Fork the repository.
- Create a new branch: git checkout -b feature/your-feature-name
- Make your changes and commit them: git commit -m 'Add some feature'
- Push to the branch: git push origin feature/your-feature-name
- Open a pull request.
- Please ensure your code adheres to the project's coding standards and passes all linting checks.