A Microverse exercise to complete the Desktop version.
- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- 📝 License
Desktop version is a starter exercise to create a porfolio capable to work in ever device, based on specific settings and requirements to ensure proper structure and best practices. By cloning this repo and running
npm install
also with properly configured linters and correct initial file structrure.
This Porfolio focuses only on
linters
and.gitignore
. No JS or Server are included in this repo.
Client
Server
- Linters: Lighthouse, Webhint, and Stylelint
- A
.github/workflows/linters.yml
file to run linters on GitHub Pull Request. - A
.gitignore
file includingnode_modules/
.
If you are a new developer and would like to have a basic project porfolio to start practicing your code or creating your first app-features, cloning this project will give you what you need! To get a local copy up and running, follow these steps:
In order to run this project you need:
- Have npm installed in your project:
curl -qL https://www.npmjs.com/install.sh | sh
Clone this repository to your desired folder:
git clone https://github.com/Gardimy/finish_mobile_version.git
or
git clone https://github.com/Gardimy/finish_mobile_version.git
<-- Only if you have SSH keys configured on your GitHub account.
run the npm install
command in your console.
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.
👤 Gardimyloaded
- GitHub: @Gardimy
- Twitter: @gardyelontiga45
- LinkedIn: Gardimy charles
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
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.
I would like to thank Microverse for teaching me these tools. And I also want to thank all my brothers for their advice.
This project is LICENCE.md 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.