Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kidd254/lawrence-s-portfolio

This is the second major project at Microverse that is intended to run for several weeks as I make changes and improvements in the course of the program
https://github.com/kidd254/lawrence-s-portfolio

Last synced: 27 days ago
JSON representation

This is the second major project at Microverse that is intended to run for several weeks as I make changes and improvements in the course of the program

Awesome Lists containing this project

README 

        
# 📗 Table of Contents



- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)



# 📖 [Lawrence-s-Portfolio] 

**[Lawrence-s-Portfolio]** is the first 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



(back to top)



## 🚀 Live Demo 



- [a link to the online version](https://kidd254.github.io/Lawrence-s-Portfolio/)



- [a link to a presentation about this project](https://www.loom.com/share/fa58332dceeb4851b77c2a69dcf63e69)



(back to top)



## 💻 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](https://git-scm.com/downloads).



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 `



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



(back to top)



## 👥 Author 



👤 **Author1**

  

- GitHub: [@Kidd254](https://github.com/Kidd254)

- Twitter: [@lawrenc98789206](https://twitter.com/lawrenc98789206)

- LinkedIn: [lawrence-kioko-972035240/](https://www.linkedin.com/in/lawrence-kioko-972035240/)



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page](../../issues/).



(back to top)



## ⭐️ 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. 



(back to top)



## 🙏 Acknowledgments 



Vote of thanks to Microverse for giving me an opportunity and ispiring me to complete this project.



(back to top)



## ❓ 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]



(back to top)



## 📝 License 



This project is [MIT](./LICENSE) licensed.