Module1-Capstone-Project

📗 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
• 📝 License

📖 [Module1-Capstone-Project]

[Module1-Capstone-Project] is the first capstone project at Microverse that is meant to test one's knowledge on gitflow and Es Linter Configuration. This project was build using Html and css. Git, Github, and Vs Code Studio were key technological tools used in this project.

🛠 Built With

This project is built using pure Html and css

🚀 Live Demo

• a link to the online version

• a link to a presentation about this project

💻 Getting Started

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

Prerequisites

In order to run this project you need: You need to have a code editor pre-installed (preferably Vs Studio Code Editor). You may also need to install Git Bash terminal but if you're using Vs Code Studio you can use its terminal.

Setup

Step 1:if you don't have git installed on your machine you can download it from here.

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 <your project link>

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

Step 2: Locate the folder where you cloned your project and open the index.html file in your browser to view your project.

Install

Install this project with:

1. install WebHint: npm install --save-dev [email protected]
2. install Stylelint: npm install --save-dev [email protected] [email protected] [email protected] [email protected]
3. install live Server from the extensions section on Vs Code Studio if using this code editor

Usage

To run the project, execute the following command: open the cloned repository in your code editor

Run tests

To run tests, run the following command:

To run tests and check for errors: -After installing the required linter, npx stylelint "/*.{css,scss}" -To fix CSS or SCSS linters error: npx stylelint "/*.{css,scss}" --fix -Run your code on web browser

Deployment

You can deploy this project using: github pages

👥 Author

👤 Lawrence Muema Kioko

• GitHub: @Kidd254
• Twitter: @lawrenc98789206
• LinkedIn: lawrence-kioko-972035240/

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project kindly offer your support in terms of contributions. If you notice any issues you can raise them in the issues section, kindly.

🙏 Acknowledgments

Vote of thanks to Microverse for giving me an opportunity and ispiring me to complete this project.I would like to thank my learning partners, and my previous partner Nelson Araujo for helping me in my project.

Above all i would like to also give credit to Cindy Shin in Behance for making the template that i used in this project available for free.

❓ FAQ

• [Where is the functionality in this project?]

  • [this project is work in progress, more changes are likely to be added in the due course]

• [What is the aim of this project?]

  • [This project is meant to equip a learner with knowledge on correct github flow, and correct es linter configuration set up]

📝 License

This project is MIT licensed.