Skip to content

kanha-gupta/Projects-showcase

Repository files navigation

Project Showcase 🚀

Welcome to the Hacktoberfest Project Showcase! This repository is a platform for developers from around the world to showcase and share their amazing projects. Whether you've built a web app, a mobile app, a cool machine learning model, or any other tech project, we'd love to see it!

Table of Contents

Introduction

This repository serves as a curated collection of outstanding projects crafted by developers globally, showcasing their creativity, innovation, and technical prowess. This repository will catalog links to the source code of each project, accompanied by its relevant documentation, providing a comprehensive overview for enthusiasts and other developers to explore and understand the projects in depth.

Project categories

There are 3 categories as of now :

  • Hackathon projects
  • Personal projects
  • Group projects

Feel free to create a new category if existing categories are not suitable

Contribution Guidelines

We welcome contributions from everyone! Whether you're a seasoned developer or a beginner, your contributions are valuable to us.

  • File contents- Contributors should list their projects in the category in .md file format.
    • File should have atleast these following contents -
      1. Project description
      2. Link to their projects source code and deployment(if available)
      3. Tech stack
      4. Your github profile
    • Template for the file,
      ---
      title: Name of the project
      description: description about your project
      link: to the projects source code and deployment(if available)
      tech stack:
        - technologies
        - used
        - in the project
      github profile link: url to your github profile
      ---
  • File naming conventions - File should be name with the title of their project or a should describe what project do. For Example : if project is about ecommerce website for shoes, file name can be 'shoes-ecommerce-website.md'
  • If you require to put multiple files, Please consider making a subfolder for it following prescribed naming convention.

Getting Started

  1. Fork this repository.
  2. Clone your forked repository to your local machine.
git clone https://github.com/kanha-gupta/Projects-showcase.git
cd Projects-showcase
  1. create a .md file with naming conventions prescribed and Put content in it
  2. Commit your changes with a meaningful commit message.
git add .
git commit -m "Your meaningful commit message here"
  1. Push your changes to your forked repository.
git push origin main
  1. Create a Pull Request to this repository. (Option to create will be available in the repository after you make the Pull request)
  2. Wait for your Pull Request to be reviewed and merged!

Please ensure that your code is properly commented and follows best practices.