Skip to content

Latest commit

 

History

History
87 lines (56 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

87 lines (56 loc) · 3.59 KB

Contributing to Beyond Classroom

Thank you for considering contributing to Beyond Classroom! Your contributions are important in enhancing the experience for the students of IIT Jodhpur. This personal blog website is built using the MERN (MongoDB, Express, React, Node.js) stack, and it allows students to share their thoughts, ideas, and experiences with the community. Here's how you can get involved:

Getting Started

To contribute to this project, you need to set it up on your local machine. Follow these steps:

  1. Clone the repository to your local machine:
git clone https://github.com/<username>/iit-jodhpur-personal-blog.git
  1. Install project dependencies by running:
npm install
  1. Start the development server:
npm start

  1. Set up a MongoDB database and add the connection string to the .env file in the project's root directory.

  2. Visit http://localhost:3000 in your web browser to view the website.

Contributing Guidelines

We welcome contributions in various forms, including bug fixes, new features, improvements, and more. Here's how you can contribute:

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your contribution: git checkout -b feature/your-feature-name.
  3. Make your changes and commit them with clear and descriptive commit messages.
  4. Push your branch to your GitHub repository.
  5. Create a pull request (PR) to the main branch of this repository.
  6. Provide a detailed description of your changes in the PR.
  7. Our team will review your PR, provide feedback, and merge it if everything looks good.

What Can You Contribute?

You can contribute to Beyond Classroom in various ways:

Adding Features

Feel free to add new features that can improve the user experience, such as social media sharing functionality, an option to notify the admin of inappropriate content, an admin panel to manage posts and users, or additional options to categorize and filter posts.

Enhancements

You can help improve the existing features, fix bugs, enhance the user interface, or optimize the codebase.

Documentation

Improving documentation, including code comments, README enhancements, or adding helpful documentation for users and contributors, is always appreciated.

What's Been Done

Here's a list of what has been implemented in the project so far:

  • Students can create their own personal blogs and share their thoughts with the community.
  • CRUD functionality for blog posts.
  • Comment system for posts.
  • User authentication and authorization.
  • User-friendly interface with responsive design.
  • Ability to search and filter posts by title and content.
  • Ability to add comments and reply to other comments.

To-Do List

Here are some features and enhancements that we'd like to add to the project. Feel free to pick one from the list and contribute:

  • Social media sharing functionality.
  • Option to notify the admin of inappropriate content.
  • Admin panel to manage posts and users.
  • Option to add categories to posts.
  • Option to view the most popular posts.
  • Option to view the recent posts.
  • Option to view the top authors.

Deployment

The website is currently deployed on render. You can visit the live website to see how it works.

Thank you for contributing to Beyond Classroom and for making it a better platform for sharing knowledge and experiences among students! If you have any questions or need assistance, feel free to reach out to us through issues or discussions. Happy contributing! 🚀