- ๐ About the Project
- ๐ป Getting Started
- ๐ฅ Authors
- ๐ญ Future Features
- ๐ค Contributing
- โญ๏ธ Show your support
- ๐ Acknowledgements
- โ FAQ (OPTIONAL)
- ๐ License
The leaderboard website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service.
- HTML, CSS, JavaScript
- VSCode
- Webpack
Server
Database
- [Git Flow]
- [Good HTML, CSS and JS practices]
- [ES6, modules]
Clone this repository to get started with the project, make sure to configure linters by following the instructions in the Linters README file
In order to run this project you need:
- A working computer.
- Connection to internet.
- npm and Node.js installed, if you don't have them, please follow this simple installation guide.
- Clone the folder to your local machine.
- Open a local copy of the project in your code editor.
- Open the index.html file from the
/dist
folder in your browser. - Run
npm install
to install all dev dependencies for Linters, Webpack & Babel.
To run the project, execute the following command:
- Run
npm run start
in your command terminal.
- After pushing the changes on github, merge your pull request and let github action process changes and fix errors, if any.
- For stylelint errors run:
sudo npx stylelint "**/*.{css,scss}" --fix
for automatic fix.
๐ค Ashmal Zahra
- GitHub: @ashmalzahra
- Twitter: [@AshmalZahraa(https://twitter.com/AshmalZahraa)
- LinkedIn: ashmal-zahra
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Give a โญ๏ธ if you like this project!
I would like to thank Microverse for the information provided to build this project.
-
Can I use the project for any purpose?
- Yes, you can.
-
Is the information saved in any database?
- No, all data is saved in Local Storage.
This project is MIT licensed.