logo

Code-review-project

📖 code_review-project

This is my first exercice code review.

code_review-project is a starting microverse exercice to create some comments in order to give feedback.

🛠 Built With

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Client
Server
Database

(back to top)

🚀 Live Demo

Add a link to your deployed project.

(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, 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/review-trial-project.git

or

git clone https://github.com/Gardimy/review-trial-project.git <-- 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

👤 Gardimyloaded

🔭 Future Features

🤝 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 Microverse for teaching me these tools.

📝 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)