ISTE-PCCOE-Website

A website for ISTE PCCOE Student's Chapter

Table of contents

1. Overview
2. Project Setup
3. Contribution Guidelines
4. Learning
5. Contributing to the Repository

About ISTE

The Indian Society for Technical Education (ISTE) is the leading National Professional non-profit making Society for the Technical Education System in our country with the motto of Career Development of Teachers and Personality Development of Students and overall development of our Technical Education System. Being the only national organisation of educators in the field of Engineering and Technology, ISTE effectively contributes in various missions of the Union Government. The strength of ISTE is the strong base it has in technical education institutions in the country.

How to set up the project locally 🚀

1. Install npm (If already installed skip this step. Feel stuck? refer https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
2. Clone the respository -

   git clone https://github.com/ISTE-PCCoE-Web/frontend.git

3. Open repository file in you preferred IDE.
4. Install dependencies by using -

   npm i

5. Run the development server with

   npm start

Contribution Guidelines 📃

1. To contribute to the codebase, please create a new branch for your changes and submit a pull request (PR) once the changes are complete.
2. When submitting a commit message, please ensure that it accurately reflects the changes made and includes a brief description of the changes.
3. We expect all communication to be conducted in a professional and respectful manner. The use of offensive language or behavior may result in the rejection of your contribution or suspension from the repository.
4. Please do not merge any code changes without a review by at least one designated reviewer to ensure that no files are lost or corrupted in the process.

Learning📚

Feeling intimidated? Don't worry. Here are some articles that might help you out.

1. GitHub Essentials - https://www.freecodecamp.org/news/introduction-to-git-and-github/
2. How to raise a PR - https://www.shecancode.io/blog/how-to-raise-a-pull-request-pr-on-github
3. Learn React - React documentation.
4. Learn Chakra- https://chakra-ui.com/getting-started
5. Learn Spline-https://docs.spline.design/ https://www.schoolofmotion.com/blog/3d-design-with-spline

Not into reading? Check out the following videos

1. GitHub Tutorial - https://www.youtube.com/watch?v=RGOj5yH7evk
2. Learn React - https://www.youtube.com/watch?v=bMknfKXIFA8
3. Learn Spline -https://docs.spline.design/05c7a5aabab041d2876cd3222d92ca32

Contributing to the Repository

Thank you for considering contributing to our repository! Here's how you can get started:

1. Clone the Repository: Clone the repository to your local machine:

   
   git clone <repository_url>

2. Create your feature or issue branch: Create a new branch for your feature:

   
   git checkout -b github_username/your-feature-name

3. Make and Commit Changes: Make your changes and commit them:

   
   git add .
   git commit -m "Add description of changes"

4. Sync with master: Keep your branch up-to-date with the master branch:

   
   git checkout master
   git pull origin master
   git checkout <your branch name>
   git merge master

5. Push Your Changes: Before Pushing your changes make sure you perform the above step: Push your branch to the repository:

   
   git push origin github_username/your-feature-name

6. Create a Pull Request: Navigate to the Pull Requests section of the repository on GitHub. Click on the "New Pull Request" button. Set the base repository and base branch to the appropriate values. Provide a descriptive title and details about your changes. Click the "Create Pull Request" button.

7. Review and Merge: Other contributors will review your pull request. They may provide feedback or request changes. Once your pull request is approved by maintainers, your changes will be merged into the master branch.

8. Delete Your Branch (Optional but preferred as you might do the changes in other branches and commit from the other if there are many branches other than the master): After your changes are merged, you can delete your feature branch:

   
   git branch -d github_username/your-feature-name

Thank you for your contributions!