Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rileymanda/html5-portfolio-website

Portfolio project built to showcase my skills and experience with HTML CSS and Javascript semantics, git-flow, setup of linters, and code reviews and PR, as well as working with feature branches in a collaboration environment.
https://github.com/rileymanda/html5-portfolio-website

css3 flexbox flexbox-grid gitflow-workflow grid-layout html5 javascript

Last synced: about 1 month ago
JSON representation

Portfolio project built to showcase my skills and experience with HTML CSS and Javascript semantics, git-flow, setup of linters, and code reviews and PR, as well as working with feature branches in a collaboration environment.

Awesome Lists containing this project

README 

        



# 📗 Table of Contents



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

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

    - [Tech Stack](#tech-stack)

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

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

- [🔑 Key features](#key-features)

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

- [🎥 Project Presentation](#project-presentation)



- [👥 Authors](#authors)

- [🤝 Contributing](#contributing)

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

  -- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)



# 📖 [Portfolio-website] 



**[Portfolio-website]** Portfolio project built to showcase my skills and experience with HTML CSS semantics, git-flow, setup of linters, and code reviews and PR, as well as working with feature branches in a collaboration environment. The portfolio is a translation of a Figma UX design provided with stipulated requirements testing my attention to detail, ability to parse Figma design, and the use of grid layout and flexbox for responsive web design. The portfolio was developed with a mobile-first approach and RWD was implemented to support desktop with media queries and grid layout.



## 🛠 Built With 



### Tech Stack 



  Javascript runtime environment

  



  Version control

  



  Github Pages

  



### Key Features 



- **[Responsive Website]**

- **[Works Section]**

- **[About Section]**

- **[Contact Section]**

- **[Mobile Menu]**



(back to top)



## 🚀 Live Demo 



- [Live Demo Link](https://rileymanda.github.io/portfolio-website/)



## 🚀 Project Presentation 



- [Project Presentation](https://www.loom.com/share/e96865e13e3b4e0883dc48cd1c7e7d62)



(back to top)



## 💻 Getting Started 



Creating your first "Portfolio-website" project



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



### Prerequisites



In order to run this project you need:



-A Git hub account




-Node JS




-Visual Studio Code or any other code editor of your preference




-web browser



### Setup



Clone this repository to your desired folder:


```sh

  cd my-folder

  git clone [email protected]:RileyManda/portfolio-website.git

```

Advantages of Linters:



1: improves readability-it will be easy to read and make adjustment if required easily.


2:removes silly errors before execution and code review.


3:Makes code look like written by a single person.


4:Spreads awareness and ownership over code quality


5:Having more secure and performant code.



## Install Linters



You can find linters for most of the programming languages, e.g. Rubocop for Ruby or ESLint for JavaScript.



Also, there are many ways you can integrate a linter in your workflow:



-text editor plugin


-GitHub Actions


-GitHub apps



## Set up Linters



**Note:** The npm package manager is going to create a node_modules directory to install all of your dependencies. You shouldn't commit that directory. To avoid that, you can create a .gitignore file and add node_modules to it:



# .gitignore



node_modules/



## Web Hint



This is a customizable linting tool that helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors.



**NOTE:** If you are using Windows, make sure you initialize npm to create `package.json` file.



```

npm init -y

```



1. Run

   ```

   npm install --save-dev [email protected]

   ```

   _how to use npm: (https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)._

2. Copy [.hintrc](.hintrc) to the root directory of your project.

3. **Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.**

   - If you think that change is necessary - open a [Pull Request in this repository](../README.md#contributing) and let your code reviewer know about it.

4. Run

   ```

   npx hint .

   ```

5. Fix validation errors.



### [Stylelint](https://stylelint.io/)



A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.



1. Run



npm install --save-dev [email protected] [email protected] [email protected] [email protected]

not sure how to use npm? Read this.



2. Copy .stylelintrc.json to the root directory of your project.



3. **Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.**



If you think that change is necessary - open a Pull Request in this repository and let your code reviewer know about it. 4. Run npx stylelint "\*_/_.{css,scss}" on the root of your directory of your project.



5. Fix linter errors.



6. **IMPORTANT NOTE:** feel free to research auto-correct options for Stylelint if you get a flood of errors but keep in mind that correcting style errors manually will help you to make a habit of writing a clean code!



(back to top)



## 👥 Authors 



👤 **Riley Manda**



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

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

- LinkedIn: [rileymanda](https://www.linkedin.com/in/rileymanda/)



## 🤝 Contributing 



## 🔭 Future Features 



- [ ] **[Works Section]**

      Works section: This section will consist of a card gallery featuring work project.



- [ ] **[About me Section]**

      This feature will contain more details about me and the tech stack i am familiar with.



- [ ] **[Contact Section]**

      This feature will comprise of a contact information.



- [ ] **[RWD]**

      The site will be updated(Desktop Version) to utilize media queries for responsivenes to create a Desktop version.   



- [ ] **[Mobile Menu Details]**

      This feature will comprise of a detail view popup menu of each section of the portfolio.    



(back to top)



Contributions, issues, and feature requests are welcome!



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



## ⭐️ Show your support 



If you like this project, kindly leave a comment below and share it with someone who enjoys coding! Coding is all about continuous learning and allowing yourself to be a beginner. Keep going!



## 🙏 Acknowledgments 



I'm grateful to microverse for giving me this opportunity to grow into my full potential through continuous learning and practical challenges.

Much appreciation to my Pair Coding partners for their contributions:



**Contributions:**

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

    -Animation Transitions

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

    -Javascript click events contribution



## ❓ FAQ 



- **[Question_1]**

  Do I have to use the vs code specifically?



  - [Answer_1]

    You can use any code editor of your chose.



- **[Question_2]**

  Where can I download node JS for installation?



  - [Answer_2]

  Node Js can be downloaded here- https://nodejs.org/en/download/

  



## 📝 License 



This project is [MIT](https://choosealicense.com/licenses/mit/) licensed.



(back to top)