Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tufoinnkuo10/leaderboard
This is a game scoreboard that exhibits the different scores of the players from highest to lowest. Data is gotten and saved in the API
https://github.com/tufoinnkuo10/leaderboard
Last synced: about 1 month ago
JSON representation
This is a game scoreboard that exhibits the different scores of the players from highest to lowest. Data is gotten and saved in the API
- Host: GitHub
- URL: https://github.com/tufoinnkuo10/leaderboard
- Owner: tufoinnkuo10
- Created: 2021-10-12T12:33:11.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2021-10-15T13:03:55.000Z (about 3 years ago)
- Last Synced: 2023-03-08T19:17:20.088Z (almost 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 3.23 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Name
API Leaderboard
> This project is designed to display the User and scores of a game getting them from an API and creating them there.
> 
>
> [Live preview](https://tufoinnkuo10.github.io/leaderboard/dist/)
Additional description about the project and its features.
- Scores are inputed
- After submiting they are sent to the API
- When you refresh it updates the score board by getting back the API information
## Built With
- 
- 
- 
- 
- 
- 
- 
- 
##periquities
To get this project up and running, you should do the following;
If you wish to run the project locally, please do the following:
1.- Install Node.js and npm if you haven't already.
To install Node.js, follow the instructions on [Node.js](https://nodejs.org/en/).
To install npm, run the following command in your terminal:
``` bash
npm install -g npm
```
2.- Install webpack and linters.
To install webpack, run the following command in your terminal:
``` bash
npm install -g webpack
```
or follow the instructions on [webpack](https://webpack.js.org/).
To install linters, run the following command in your terminal:
``` bash
npm install -g eslint
npm install -g stylelint
npm install -g webhint
```
or follow the instructions on [eslint](https://eslint.org/), [stylelint](https://stylelint.io/), and [webhint](https://webhint.io/).
Also you can clone the repository and most of the jobs will be done for you.
Once you have the setup and the project locally, you can run the project using the following command in your terminal:
``` bash
npm run build
```
and if you want to watch the changes live, run the following command:
``` bash
npm start
```
also you can run ``` npm run watch ``` to make webpack watch the changes and rebuild the project without having to run the build command again.
## Tests
If you want to run the tests, do the following:
1.- Install Node.js and npm if you haven't already. Or you can use yarn if you prefer.
2.- Install Jest using npm or yarn. You can check here how to do it: [Jest](https://jestjs.io/es-ES/docs/getting-started).
3.- Run ``` npm test ``` or ``` yarn test ``` to run the tests.
4.- you can add the jest coverage so it covers all your code and show percentage left
Or
You can run ``` git clone https://github.com/tufoinnkuo10/LEADERBOARD.git ``` to clone the repository and avoid all the installation steps because tests are set as a dependency.
Happy coding!
👤 **Author**
- Name: Tufoin Nkuo
- GitHub: [@tufoinnkuo10](https://github.com/tufoinnkuo10)
- Twitter: [@itztenten](https://twitter.com/itztenten)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/tufoin-nkuo-3b272320b)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- This project is realised thanks to microverse
## 📝 License
This project is [MIT](./LICENSE.md) licensed.