README.md

GitShow 🪄

For Programmers, by Programmers

GitShow is an outright social-media platform for programmers, where you can showcase your projects hosted on the GitHub in a beautiful way.

• Write what your project is about
• Add Images, Repository Link and Deployment Link & Post
• ✨Magic ✨

Features 👀

• Show your GitHub Projects in a more friendly way.
• Check what others are creating, by just searhing their GitHub username.
• Network and Chat with fellow open source contributors throughout the world.
• Get love & suggestions from all over the world.
• Find your Pair Programmer & Collaborate with them on new projects.

Tech 🧑🏽‍💻

GitShow uses a number of open source projects to work properly:

• ReactJS - A declarative, efficient, and flexible JS library for building user interfaces.
• Tailwind CSS - A utility-first CSS framework packed with classes to build any design, directly in your markup.
• Firebase - A Backend-as-a-Service solution both for mobile and web-based applications that includes services for building, testing, and managing apps.
• Github API - API to create integrations, retrieve data, and automate your workflows through Github.

Contributing 🚀

Currently, we are in the initial phase of building the application. To minimise bugs, we are not accepting any contributions as of now. But, you can always raise issues, so that we can work on it. And probably in the future, you can work on adding new features with us!

-- Sujal & Madhavi

Running Locally 🏃🏽

1. Clone the Repository

   git clone https://github.com/MadhaviGupta/GitShow.git
   

2. Change Directory to GitShow

   cd GitShow
   

3. Install the required node packages

   npm install
   

4. In the project directory, you can now run the Project npm start Runs the app in the development mode.
   Open http://localhost:3000 to view it in your browser.
   
   Free Software, Hell Yeah!