Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/indiecodermm/commit-conquest

Commit Conquest is a game that rewards players for making git commits and allows them to compete on leaderboard. Built using Leaderboard API.
https://github.com/indiecodermm/commit-conquest

api-rest javascript leaderboard microverse

Last synced: 8 days ago
JSON representation

Commit Conquest is a game that rewards players for making git commits and allows them to compete on leaderboard. Built using Leaderboard API.

Host: GitHub
URL: https://github.com/indiecodermm/commit-conquest
Owner: IndieCoderMM
License: mit
Created: 2022-12-19T15:49:22.000Z (about 2 years ago)
Default Branch: develop
Last Pushed: 2022-12-22T08:42:38.000Z (about 2 years ago)
Last Synced: 2025-01-16T00:07:16.914Z (13 days ago)
Topics: api-rest, javascript, leaderboard, microverse
Language: JavaScript
Homepage: https://indiecodermm.github.io/commit-conquest/dist/
Size: 1.12 MB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        

[![CodeFactor](https://www.codefactor.io/repository/github/indiecodermm/commit-conquest/badge)](https://www.codefactor.io/repository/github/indiecodermm/commit-conquest)

[![Maintainability](https://api.codeclimate.com/v1/badges/0a6c8129bbba120aa360/maintainability)](https://codeclimate.com/github/IndieCoderMM/commit-conquest/maintainability)



  

  


  
Microverse Leaderboard Project




# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 Commit Conquest ](#-commit-conquest-)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

  - [🚀 Live Demo ](#-live-demo-)

  - [💻 Getting Started ](#-getting-started-)

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

  - [👨‍🚀 IndieCoderMM ](#-indiecodermm-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [🤩 Show your support ](#-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [💎 Resources ](#-resources-)

  - [📝 License ](#-license-)

# 📖 Commit Conquest 

In **Commit Conquest**, players are challenged to use their _Git Commits_ as points to climb the leaderboard. The game is designed to encourage players to actively contribute to projects, as well as to improve their skills in version control and collaboration. Players can update their progress and compete with other players in real-time.

![screenshot](leaderboard_screenshot.png)

## 🛠 Built With 

### Tech Stack 

![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)

![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)

![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)

![Webpack](https://img.shields.io/badge/webpack-%238DD6F9.svg?style=for-the-badge&logo=webpack&logoColor=black)

- [Leaderboard API](https://www.notion.so/Leaderboard-API-service-24c0c3c116974ac49488d4eb0267ade3): To collect and update the scores

### Key Features 

- **Leaderboard**: Track and view progress in real-time

- **Commit-based Points**: Earn points by making commits

- **Gamification**: Provide fun and engaging way to improve programming skills

(back to top)


## 🚀 Live Demo 

Join the challenge and see if you have what it takes to become the _ultimate Git Master_ in [Commit Conquest](https://indiecodermm.github.io/commit-conquest/dist/).

(back to top)


## 💻 Getting Started 

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need [Node.js](https://nodejs.org/en/) installed on your computer.

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone [email protected]:IndieCoderMM/commit-conquest.git

```

### Install

Install the dependencies with:

```sh

  npm install

```

### Usage

To run the project, execute the following command:

```sh

  npm start

```

(back to top)


## 👨‍🚀 IndieCoderMM 

I am always looking for ways to improve my project. If you have any suggestions or ideas, I would love to hear from you.

[![Github](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/IndieCoderMM)

[![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/hthant_oo)

[![Linkedin](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://linkedin.com/in/hthantoo)

[![Gmail](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:[email protected])

(back to top)


## 🔭 Future Features 

- [x] **Use leaderboard API to track data**

- [x] **Create a stunning UI**

- [x] **Add user interaction**

- [ ] **User registeration**

- [ ] **Social features**

- [ ] **Customizable avatar**

- [ ] **Automatic commit tracking**

(back to top)


## 🤝 Contributing 

I welcome any and all contribution that can help me improve my project. If you have any ideas or feedback that you'd like to share, please don't hesitate to reach out.

(back to top)


## 🤩 Show your support 

If you like this project, you can support me by giving a ⭐.

(back to top)


## 🙏 Acknowledgments 

I would like to thank all code reviewers for making this project better.

(back to top)


## 💎 Resources 

- Google fonts

  - [MedievalSharp](https://fonts.google.com/specimen/MedievalSharp)

  - [Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P)

- Assets

  - [GUI Essential](https://crusenho.itch.io/complete-gui-essential-pack)

  - [Pixel Art GUI](https://mounirtohami.itch.io/pixel-art-gui-elements)

## 📝 License 

This project is [MIT](./LICENSE.md) licensed.

(back to top)