Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ilyassatlassi/leaderboard
https://github.com/ilyassatlassi/leaderboard
Last synced: 16 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ilyassatlassi/leaderboard
- Owner: ilyassatlassi
- License: mit
- Created: 2023-03-08T13:20:52.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-03-11T16:40:03.000Z (almost 2 years ago)
- Last Synced: 2024-05-17T15:34:08.844Z (7 months ago)
- Language: JavaScript
- Size: 1.21 MB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# leaderboard 📝
## A solo programming project that heighlights the use of webpack to bundle JavaScript, ES6 syntax
# 🛠 Built With
### Tech Stack
- HTML5.
- CSS3.
- Javascript using ES6.
- Webpack.
### Client
- HTML.
- CSS.
- JS.
- Webpack
comming soon
### Server
- local.
### Database
- N/A.
# Key Features
- HTML5 semantics.
- CSS3.
- Javascript OOP, ES6.
- Webpack.
- Gitflow
# 💻 Getting Started
### To get a local copy up and running, follow these steps
1. Installed Git.
2. Create a local directory that you want to clone the repository.
3. Open the command prompt in the created directory.
4. On the terminal run this command git clone https://github.com/ilyassatlassi/leaderboard.git
5. Install the dev dependencies for linters run npm install.
6. run: ```npm i --save-dev webpack webpack-cli webpack-dev-server @babel/core @babel/preset-env babel-loader style-loader css-loader sass-loader html-webpack-plugin mini-css-extract-plugin ```
After Installing all the packages run this command ``` npm run start ``` to start dev server and you can just press ```Ctrl + C``` in the terminal and that will kill it and run ``` npm run build ``` to creates a build directory with a production build of your app .
# Prerequisites
### In order to run this project you need
- Installed Git.
- A browser.
# Setup
- Clone this repository to your desired folder.
# Install
### Install this project with
- Git.
- Github.
# Usage
### To run the project, execute the following command
- git clone
- cd leaderboard
# Run tests
### To run tests, run the following command
- npx eslint .
- npx stylelint "**/*.{css,scss}"
# Deployment
### You can deploy this project using
- Github pages.
# 👥 Authors
👤 ilyass atlassi
- GitHub: [@githubhandle](https://github.com/ilyassatlass)
- Twitter: [@twitterhandle](https://twitter.com/ilyass_atlassi)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/ilyassatlassi/)
# 🔭 Future Features
- Use advanced JS data structures.
- Implement some awesome animations and transitions to the design.
- Integrate back-end.
# 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
# ⭐️ Show your support
If you like this project kindly send to me an e-mail expressing it, it would make my day and fuel my motivation.
# 🙏 Acknowledgments
I would like to thank Microverse team for this journey.
# ❓ FAQ
### How do I clone this with all the un-merged branches?
- Kindly check the branches names in github then add them manually on your local machine, after that you may just pull the changes.
### How to access the database?
- It's not available for now I'm still working on it, once it's available I'll update this answer.
# 📝 License
This project is [MIT](./LICENCE.md) licensed.