Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mahammad-mostafa/leader-board-list
This is the seventh project for the second module in the Microverse program. It is a leaderboard list app fetched from an API and follows the GitFlow workflow.
https://github.com/mahammad-mostafa/leader-board-list
api await-async css3 es6 es6-modules gitflow gitflow-workflow html-css-javascript html5 javascript microverse microverse-projects microverse-students promises single-page-app webpack5
Last synced: about 1 month ago
JSON representation
This is the seventh project for the second module in the Microverse program. It is a leaderboard list app fetched from an API and follows the GitFlow workflow.
- Host: GitHub
- URL: https://github.com/mahammad-mostafa/leader-board-list
- Owner: mahammad-mostafa
- License: mit
- Created: 2023-07-25T22:37:09.000Z (over 1 year ago)
- Default Branch: development
- Last Pushed: 2023-10-03T22:54:43.000Z (over 1 year ago)
- Last Synced: 2024-10-19T02:45:17.419Z (3 months ago)
- Topics: api, await-async, css3, es6, es6-modules, gitflow, gitflow-workflow, html-css-javascript, html5, javascript, microverse, microverse-projects, microverse-students, promises, single-page-app, webpack5
- Language: JavaScript
- Homepage: https://mahammad-mostafa.github.io/leader-board-list/dist
- Size: 309 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 🏷️ Leader Board List
This is the seventh project in the second module of the **Microverse** program.
Check the below contents for further details about this project.
# 📗 Contents
- [Description](#description)
- [Instructions](#instructions)
- [Authors](#authors)
- [Future](#future)
- [Contributions](#contributions)
- [Support](#support)
- [Acknowledgements](#acknowledgements)
- [License](#license)
# 📖 Description
This project is a simple leaderboard list app with `ES6` modules and bundled with `WebPack`.
It consumes data from an external `API` and follows `GitFlow` workflow.
Scores are loaded with asynchronous calls using `async` functions & `promises`.
All project files are contained in `src` directory.
Also config linters for (`HTML` / `CSS3` / `JavaScript`) in the `.github` folder.
📌 **Live Demo:**
- See the project live from [here](https://mahammad-mostafa.github.io/leader-board-list/dist).
📌 **Tech Stack:**
- Page strucutre is built with `HTML5`
- Styling is built with `CSS3`
- Dynamic content is built with `JavaScript`
- Bundling is done with `WebPack`
📌 **Key Features:**
- Responsive layout for all screens
- Dark themed color palette
- Inserts new player name & score
- Automatic loading of players scores
- List scrolling when height overflows
# 🛠️ Instructions
You can easily download or fork this repository and work on it immadiately!
📌 **Prerequisites:**
- `NodeJS` for installing & running all packages
📌 **Installation:**
- Install all dependencies with `npm`
```
npm install
```
📌 **Development:**
- For live development on `localhost:8080` run:
```
npm run start
```
📌 **Deployment:**
- You can deploy this project by uploading files in the `dist` folder to a live server.
- Create the distribution build using this command:
```
npm run build
```
# 👥 Authors
📌 **Mahammad:**
- [GitHub](https://github.com/mahammad-mostafa)
- [Twitter](https://twitter.com/mahammad_mostfa)
- [LinkedIn](https://linkedin.com/in/mahammad-mostafa)
# 🔭 Future
Some additional features I may implement in the project:
- [ ] Using `CSS` preprocessors and their relevant loaders
- [ ] Implement two `WebPack` configurations for production & development
# 🤝🏻 Contributions
Wish to contribute to this project?
Contributions, issues, and feature requests are more than welcome!
Feel free to check the [issues](../../issues) page too.
# ⭐️ Support
Like this project? Show your support by starring!
# 🙏🏻 Acknowledgements
I thank everyone at **Microverse** for guiding me through this project.
# 📝 License
This project is [MIT](LICENSE.md) licensed.