📗 Table of Contents

• 📖 About the Project
• 🛠 Tech Stack
• Key Features
• 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Deployment
• 👥 Author
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Art Work

JavaScript project - API-based webapp, using webpack and ES6 features, notably modules.

🛠 Tech Stack

• HTML
• CSS
• JavaScript ES6
• NodeJS
• Webpack

Key Features

• Use callbacks and promises
• Use ES6 modules to write modular JavaScript.
• Use webpack to bundle JavaScript.

(back to top)

🚀 Live Demo

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:

• GIT
  • if you don't have git installed on your machine you can download it from here.
• Linter
  • You can get install guide from here
• Node.js & Npm
  • if you don't have npm installed on your machine you can download it from here

Setup

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

  git clone git@github.com:dev-mamun/javascript-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

Install

Install this project with:

  cd javascript-capstone
  npm install

Usage

To run the project, use the following : (Port 3000)

  npm run dev
  browse http://localhost:3000/

(back to top)

Run 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

👤 Salma Ibrahim

• GitHub: @Saluumaa
• Twitter: @SalmaHIbrahim20
• LinkedIn: Salma ibrahim

👤 Santosh Konappanavar

• GitHub: @Santosh-Konappanavar
• Twitter: @SantoshKonapp1
• LinkedIn: @Santosh Konappanavar

🔭 Future Features

• adding more components
• login and logout pages should be added

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

If you like this project feel comfortable to endorse the author.

(back to top)

🙏 Acknowledgments

I would like to thank...

• Teammates
• YouTube tutorials
• Microverse guides
• Google Search

(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 OOP?

• With this type of programming, a program comprises objects that can interact with the user, other objects, or other programs. This makes programs more efficient and easier to understand.

(back to top)

📝 License

This project is MIT licensed.

(back to top)