Learn.md

Learn.md ✍

Campus-Space 🖥️

Campus Space is a MERN stack project with TypeScript & Tailwind CSS. Admins manage timetables, teacher absences, & rooms. Students & teachers view timetables, vacant rooms, & teacher absences. Teachers can book rooms for classes. Efficient college resource management.

Table of Contents

1. Tech Stack
2. Contributing
   • Development Workflow
   • Issue Report Process
   • Pull Request Process
3. Setting Up on your machine
4. Usage
5. Resources for Beginners
   • Basics of Git and GitHub
6. Documentation
7. Code Reviews
8. Feature Requests
9. Spreading the Word

Tech Stack

• MongoDB
• Express
• React
• Node. js
• Tailwind CSS
• TypeScript

Contributing 📝

Raise and issue; Get assigned and then work on fixing the issue. We welcome contributions to Campus-Space! Follow these steps to contribute:

1. Fork the Repository: Create your own copy of the repository on your GitHub account.

2. Clone the Repository : Clone the repository for making commits.

   git clone https://github.com/your-username/Campus-Space.git

   
   

3. Create a New Branch for your feature or bug fix: Make a separate branch to work on specific features or fixes and switch to the correct branch.

git checkout -b <new-branch-name>

4. Make Changes and commit them: Implement your changes and save them with a descriptive commit message.

git add .
git commit -m "Describe your changes"

5. Push Your Changes to your fork: Upload your committed changes to your GitHub fork.

   git push origin <branch_name>

6. Create a Pull Request ✅: Propose your changes to be merged into the original repository.
   

Development Workflow

• Always work on a new branch for each issue or feature.
• Keep your branch up to date with the main repository's master branch.
• Write clear and descriptive commit messages.
• Test your changes thoroughly before submitting a pull request.

Issue Report Process

1. Go to the project's issues section.
2. Select the appropriate template for your issue.
3. Provide a detailed description of the issue.
4. Wait for the issue to be assigned before starting to work on it.

Pull Request Process 🚀

1. Ensure that you have self reviewed your code.
2. Make sure you have added the proper description for the functionality of the code.
3. I have commented my code, particularly in hard-to-understand areas.
4. Add screenshot it help in review.
5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon.

Setting Up on your machine

Follow these steps to set up the project locally:

Clone the project

  git clone https://github.com/sethshivam11/campus-space.git

Go to the project directory

  cd campus-space

Install dependencies

  npm run build

Start the server

  npm run start

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

MONGODB_URI

PORT

ACCESS_TOKEN_SECRET

NODE_ENV

• Click Here for Server Side .env.sample file.

If you want to change the name of the college, image or footer links edit the env.production file in the client folder VITE_COLLEGE_NAME VITE_TWITTER VITE_GITHUB VITE_LINKEDIN VITE_LOGO

• Click Here for Client Side .env.sample file.

Usage

1. Register a new account or log in with an existing account.

2. You can get all the details about vacant rooms, Your timetable, Teachers absent, list of classes available at a particular period of time

3. There are more features and various ways to connect.

Contributions are welcome!. You can suggest features to add, report any possible bug that might crept in, ideas and changes! 🚀

Resources for Beginners 📚

Basics of Git and GitHub 📂

• Forking a Repo
• Cloning a Repo
• Creating a Pull Request
• Getting Started with Git and GitHub
• Learn GitHub from Scratch

Documentation

• Document any significant changes or additions to the codebase.
• Provide clear explanations of the functionality, usage, and any relevant considerations.

Code Reviews 🔎

• Be open to feedback and constructive criticism from other contributors.
• Participate in code reviews by reviewing and providing feedback.

Feature Requests 🔥

• Suggest new features or improvements that would enhance the project.

Spreading the Word 👐

• Share your experience and the project with others.
• Spread the word about the project on social media, developer forums, or any relevant community platforms.

Thank you for contributing to Campus-Space! Together, we can make a significant impact. Happy coding! 🚀

Don't forget to ⭐ the repository!