Module 2: JS Group Capstone - Grils shows

📗 Table of Contents

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

📖 Leaderboard

Girls shows is a simple web app that fetches aswell as store data in multiple apis and display them it uses modular architechture aswell as webpack.

🛠 Built With

HTML, CSS, NodeJS v18

Tech Stack

Structure

• HTML

Style

• CSS

Module Bundler

• Webpack

Linters

• Webhint
• Stylelint
• ESLint

Key Features

• Modular JS architecture.

  • Use Modules.

• Module Bundler.

  • Use Webpack.

(back to top)

🎥 Video Demo

• Here you'll watch a short video documenting the project: Link

(back to top)

🚀 Live Demo

• Link

(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: Open terminal on the same folder of the project and run:

 npm install

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com/codedit334/JS_Group_Capstone.git

Install

Install this project with:

  cd JS_Group_Capstone
  npm install

Usage

Run Dev Server (Port 3001)

  npm run dev

Build for production

npm run build

Run tests

• Linter Tests

To run tests, run the following command:

To check for html errors run:

  npx hint .

To check for css errors run:

  npx stylelint "**/*.{css,scss}"

To check for js errors run:

  npx eslint .

👥 Authors

👤 Author1

• GitHub: @codedit334
• Twitter: @oussedit
• LinkedIn: Oussama Elabdioui

👤 Author2

• GitHub: @ilyassatlass
• Twitter: @ilyass_atlassi
• LinkedIn: Ilyass Atlassi

🔭 Future Features

• Google Analytics.

(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 send your feedback to encourage me to do more.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for offering me this opportunity to learn, and practice my skills.

(back to top)

❓ FAQ

-Why use linters?

• The use of linters helps to diagnose and fix technical issues, also linters can help teams achieve a more readable and consistent style, through the enforcement of its rules.

-Why use modular programming?

• Modular programming usually makes your code easier to read because it means separating it into functions that each only deal with one aspect of the overall functionality.

-Why use a Bundler?

• It keeps track of which files depend on which other files and ensures they are loaded in the right order. This helps make your code more modular and easier to maintain.

(back to top)

📝 License

This project is MIT licensed. (Check the LICENSE file)

(back to top)