GitBit

◦ An online monitoring 🎢 and tools 🪛 One Stop Shop for Github ✅

◦ Developed with MERN, Fastn and other cutting edge tools.

📖 Table of Contents

📖 Table of Contents
📍 Overview
📦 Features
📃 Documentation
📂 Repository Structure
⚙️ Modules
🚀 Getting Started
🛣 Roadmap
🤝 Contributing
📄 License
👏 Acknowledgments

📍 Overview

GitBit is an online one stop solution for every devloper who uses Github and especially helpful for all new developers in the stream and can help them a lot by being thier handy partner in terms of all tools in one place organized and daily add ons to the page, just like a library full of new and creatuve books to enhance user's productivity.

The aim is to develop a compact yet effective web-app which delivers to the current need of community work (eg. Community Leaderboard, Tools for registered users), along with individual user focused materials like User Dashboard and advanced statiscially detmined and visualized user development metrics.

📦 Features

The possible features for the project are endless, but as an origin of a Hackathon we trusted the development process and were able to fully manage to deploy given features for the users by the end of this project submission deadline:

Initial setupless- One Click Dashboard for a valid user profile.
Support for Login using secure oAuth 2.0
Community Format support style (for all development members)
LeaderBoard to mark progress (for platform registered members only)
Collection of Home Grown as well as community contributed tool projcts that can help your Github lifecycle a work of breeze and joy.

Note ⭐

Who says one can only deploy a web or just an android app in a 36-hour hackathon. We did it!! We did both for you guys (although not too much but yes we did both of them!!) You can download the Android Installer APK in the Releases Section of the repository.

📂 Repository Structure

└── GitBit/
    ├── LICENSE
    ├── README.md
    ├── CONTRIBUTING.md
    └── src/
        ├── assets
        ├── Backend
        ├── Components
        ├── Store
    └── public/
    └── dist/

⚙️ Modules

Src

File	Summary
App.jsx	Contains all Routes to the pages using React-Router along with a private route that encapsulates all other feature routes for logged in users.

🚀 Getting Started

Dependencies

Please ensure you have the following dependencies installed on your system:

- ℹ️ NodeJS

🔧 Installation

Clone the GitBit repository:

git clone https://github.com/047pegasus/GitBit

Change to the project directory (on master branch for Web and android brsnch for Android):

cd GitBit

Install the dependencies: Web Install using node:

npm install

Android Install using Pub in Flutter :

flutter pub add

🤖 Running GitBit:

You are already in position to roll the application!! ✅🚀

In a terminal open two sessions and run each command group in a separate session.

npm start

cd src/backend
node {APP}.js

Note: Here {APP.js} refers to all the backend files to connect to each collection hosted on the database on Mongo Atlas.

🛣 Roadmap

ℹ️ Task 1: Fix Android Bug on Login/SignUp (problems due to oAuth 2.0 usage unavailability in Andorid both using Firebase or using Mongo Realm SDK)

ℹ️ Task 2: Improve user Onboarding process Page (Leaderboard slow response time due to use of REST APIs in place of GraphQl APIs)

ℹ️ Task 3: Implement Tool Management API base addition feature for listing a new tool on basis of a form, user can fill up to feature their tool ont he webapp database.

🤝 Contributing

Contributions are always welcome! Please follow these steps:

Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project.
Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop.
Create a new branch with a descriptive name (e.g., new-feature-branch or bugfix-issue-123).

git checkout -b new-feature-branch

Make changes to the project's codebase.
Commit your changes to your local branch with a clear commit message that explains the changes you've made.

git commit -m 'Implemented new feature.'

Push your changes to your forked repository on GitHub using the following command

git push origin new-feature-branch

Create a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary. The project maintainers will review your changes and provide feedback or merge them into the main branch.

📄 License

This project is licensed under the ℹ️ LICENSE-TYPE License. See the LICENSE-Type file for additional info.

👏 Acknowledgments

We also would like to thank all the third party tools that we list on our project to help all the users through our website. Without these tools our project would not have been possible and we would like to thank all of these amaziong tools avaialable online to help us, ultimately help the dev community. Although we support all these endeavours, some of the top tols that we readily make availble to ur users in this alpha release of the application include the following:

https://github.com/Platane/snk

https://github.com/ShashwatPS/Forest_Farmer

https://github.com/047pegasus/Zephyr/blob/sps/Web/src/Pages/Gsoc.jsx

https://github.com/047pegasus/Zephyr/blob/sps/Web/src/Pages/Trending.jsx

↑ Return

047pegasus / GitBit