AlexisJW/leadearbord

Leaderboard

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Microverse Student
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Project - Leaderboard

Leaderboard list app is a JavaScript project that uses webpack and ES6 features, including modules. Developed from wireframe and uses API using asynchronous and pending JavaScript.

🛠 Built With

By Microverse Student, Alexis

Client

• HTML
• CSS
• JavaScript
• Webpack
• linters
• Visual Studio

Server

• webpack-dev-middleware

Database

• Comming soon

Key Features

• [Set up a JavaScript project for the Leaderboard list app]
• [Use callbacks and promises.]
• [Learn how to use proper ES6 syntax..]
• [Use ES6 modules to write modular JavaScript.]
• [Use webpack to bundle JavaScript.]
• [Write plain HTML markup with minimum styling (just to make the layout).]
• [The section "Featured speakers" is created dynamically in JavaScript.]
• [Deploy the project.]
• [Open a pull request.]

(back to top)

🚀 Live Demo

• Live Demo

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

If you don't have git installed on your machine you can download it from here.

If you need to run my project locally follow the steps below :

• Have git installed. (For version control)
• Have text editor installed. (Preferablly VSCode)
• Have node installed.
• Have npm package manager Installed.
• Have webpack installed. (module bundler)
• Have CSS,HTML & JS Linters installed and configured. For further information, visit this link to get better understanding on each linters used on this project.
• Properly use ES6 Syntax and ES6 Modules throughout the project.

Setup

Clone this repository to your desired folder:

Once you have git installed on your machine you can clone your project by running the command below to clone your project to your local machine

git clone <https://github.com/AlexisJW/M1-Capstone.git>

Alternatively, you can download the zip file of your project by clicking on the Code button on the right side of your project page and clicking on Download ZIP

Installation

1. First, Initialize NPM Package Manageer

npm init -y

2. Install Webpack, Required plugin(s), Style/CSS Loader and Webpack-dev-server

npm install webpack webpack-cli --save-dev
npm install --save-dev html-webpack-plugin
npm install --save-dev style-loader css-loader
npm install --save-dev webpack-dev-server

3. Start running build

npm build run
npm start

(back to top)

Usage

To run the project, execute the following command: Locate the folder where you cloned your project to and open the index.html file in your browser to view the project.

Run tests

To run tests, run the following command:

• No tests at the moment.

👥 Authors

👤 Jean Walner ALEXIS

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Make some changes]
• [Code Review]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, let me know in my email: jeanwalneralexis@yahoo.com, please!

(back to top)

🙏 Acknowledgments

• Microverse
• Coding Partners
• Code Reviewers

(back to top)

❓ FAQ

• [How much times did you spend to build this project?]

  • [Only 10 hours.]

(back to top)

📝 License

This project is MIT

(back to top)