https://github.com/lukman155/leaderboard

https://github.com/lukman155/leaderboard

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/lukman155/leaderboard
• Owner: lukman155
• License: mit
• Created: 2022-11-15T11:17:20.000Z (almost 2 years ago)
• Default Branch: dev
• Last Pushed: 2022-12-09T09:42:11.000Z (almost 2 years ago)
• Last Synced: 2023-05-06T20:20:44.370Z (over 1 year ago)
• Language: HTML
• Size: 347 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  

  


  
LeaderBoard README




# 📗 Table of Contents

- [📖 About the Project](#about-project)

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

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

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

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)

# 📖 [Leaderboard] 

> Describe your project in 1 or 2 sentences.

**[Leaderboard]** is a Web application that is serviced by an API that allows storage and retrieval of data in text format.

## 🛠 Built With 

### Tech Stack 

  Client

  


    
React.js

  


  Server

  


    
Express.js

  


Database

  


    
PostgreSQL

  


### Key Features 

> Describe between 1-3 key features of the application.

- **[Storage of data on a remote file server]**

- **[Retrieval of data from the remote server]**

(back to top)


## 🚀 Live Demo 

> Add a link to your deployed project.

- [Live Demo Link of Leaderboard App](https://lukman155.github.io/leaderboard/dist/)

(back to top)


## 💻 Getting Started 

> Describe how a new developer could make use of your project.

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

### Prerequisites

In order to run this project you need:

```

 To install node

```

### Setup

Clone this repository to your desired folder:

  git clone https://github.com/lukman155/leaderboard.git

### Install

Install this project with:

  cd my-project

  npm install

--->

### Usage

To run the project, execute the following command:

```sh

  npm start

```

(back to top)


## 👥 Authors 

> Mention all of the collaborators of this project.

👤 **Lukman Abdulkarim**

- GitHub: [@lukman155](https://github.com/lukman155)

- Twitter: [@LukmanAbdulka18](https://twitter.com/LukmanAbdulka18)

- LinkedIn: [Lukman Abdulkarim](https://linkedin.com/in/lukmanbaba)

(back to top)


## 🔭 Future Features 

> Describe 1 - 3 features you will add to the project.

- [ ] **[Create interactive elements]**

- [ ] **[Use an animated background]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/lukman155/leaderboard/issues).

(back to top)


## ⭐️ Show your support 

If you like this project, please drop a star ⭐️ or two⭐️⭐️...cheers

(back to top)


## 🙏 Acknowledgments 

> Give credit to everyone who inspired your codebase.

I would like to thank my coding partners and the coding community. y'all are truly the best.

(back to top)


## 📝 License 

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

(back to top)