📗 Table of Contents

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

📖 JavaScript Capstone

The JavaScript Capstone project at Microverse is an opportunity for students to showcase their skills in building a full-stack web application. Students work in teams to develop a project from scratch, using technologies such as Html,Css,JavaScript at the end of second Module. The project involves designing and implementing a user interface, using a RESTful API. The Capstone project is a challenging and rewarding experience that prepares students for real-world software development.

🛠 Built With Love and Passion

Tech Stack

Key Features

• Unit Testing
• Html and Css best paractice
• JavaScript best paractice
• Using gitflow and GitHub flow

🚀 Live Demo

🚀 Video Presentation

💻 Getting Started

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

Prerequisites

In order to run this project you need:

Download Project Files from github.

Setup

Clone this repository to your desired folder:

Install

Install Node Package by running:

• npm install

Usage

• In other to use the repo you either to create a branch to create new features.
• But in order to run the project use the commands below:
  • npm run build (It will create a production ready file)
  • npm start (It will run the server on your local machine)

Run Linters (Testing)

I have added Linters different kinds of Linters to help avoid typos and ensure the best practices of the code base. So while using this repository if you need to check your work no matter if you have worked on HTML or CSS, or even JS you can use the commands below.

• To run the linter test on index.html or any HTML file. Use the below command:
  npx hint .

-To run linter test on Stylesheets (CSS or sass). Use the below command: npx Stylelint "**/*.{css,scss}"

• To run linter test on ES Lint (JS). Use the below command:
  npx eslint .

Deployment

N/A

👥 Authors

Mention all of the collaborators of this project.

👤 Author Glauber Bannwart

• GitHub: @cancelei
• LinkedIn: LinkedIn

👤 Author Amir Hussain Habibi

• GitHub: @Salarhabibi-amir
• LinkedIn: LinkedIn

🔭 Future Features

• Use Linters
• Use Webpack
• Use Gitflow

🤝 Contributing

N/A

⭐️ Show your support

N/A

🙏 Acknowledgments

We are gratefull of Microvers stuff and founder for creating such an amazing envirnment that we can work and learn.

📝 License

This project is MIT licensed.