Capstone project

A Microverse exercise to use animation on a website

Capstone project

📗 Table of Contents

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

📖Capstone Project

Capstone project This project was a requirement of module one, where we learned HTML, CSS and JavaScript, also the importance of git workflows following best practices of committing early and often. The use of linters to ensure code quality follows the HTML and CSS best practices. It is based on specific settings and requirements to ensure proper structure and best practices. By cloning this repo and running npm install we will have a basic Capstone project with properly configured linters, eslint and the correct initial file structure.

🛠 Built With

Tech Stack

This project focuses only on linters and .gitignore. and JS or Server are included in this repo.

Client

• HTML
• SCSS
• JavaScript

Server

• Netlify

Key Features

• Linters: Lighthouse, Webhint, and Stylelint
• A .github/workflows/linters.yml file to run linters on GitHub Pull Request.
• A .gitignore file including node_modules/. -Eslintnpm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x [ -f .eslintrc.json ] || wget https://raw.githubusercontent.com/microverseinc/linters-config/master/html-css-js/.eslintrc.json - name: ESLint Report

🚀 Live Demo

• Live Demo Link

🚀 Video

• Video Presentation Link

(back to top)

💻 Getting Started

If you are a new developer and would like to have a basic project to start practicing your code or creating your first portfolio app-features using good practice JavaScript ,HTML and CSS : Cloning this project will give you what you need!

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

Prerequisites

In order to run this project you need:

• Have npm installed in your project: curl -qL https://www.npmjs.com/install.sh | sh

Setup

Clone this repository to your desired folder:

git clone https://github.com/Gardimy/Mobile-first

or

git clone https://github.com/Gardimy/Mobile-first <-- Only if you have SSH keys configured on your GitHub account.

Install:

run the npm install command in your console.

Usage

To run the linters before committing any changes to your code, execute the following commands:

npx hint . npx stylelint "**/*.scss" <--NOTE: this repo is set up to use with SCSS. If you would like to use CSS, you must replace "**/*.scss" with "**/*.{css,scss}" in line 48 of the .stylelintrc.json file, and run the linter with:

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

(back to top)

👥 Authors

👤 Gardimy Charles

• GitHub: @Gardimy
• Twitter: @gardyelontiga45
• LinkedIn: Gardimy charles

🔭 Future Features

• ESLint.

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project please give me a star on GitHub.And Don't hesitate to follow me on github, you will have the opportunity to get all updating available for this project.

🙏 Acknowledgments

I would like to thank Cindy Shin for Preparing this guideline which help me build my Website.

📝 License

This project is MIT license licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)