RileysPortfolio

📗 Table of Contents

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

📖 RileysPortfolio

A Work In Progress github portfolio project built with react+vite, meticulously crafted to display public repositories from my github account utilizing the github Api.

🛠 Built With

Tech Stack

React

• React.js

Redux-toolkit

• Redux-toolkit

Axios

• Axios

Node js

• Node

Localstorage

• Localstorage

Linters and Worflows

• Linters and github workflow-actions

Rest-API

• Github API

React Bootstrap

• React Bootstrap

React Testing Library

• React Bootstrap

🛠 Key Features

Features

Projects

Work experience

Skills

Contact component

(back to top)

🚀 Live Demo

• Live Demo

(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:

Setup

Clone this repository to your desired folder:

cd my-folder
git clone https://github.com/RileyManda/rileysportfolio.git

Install

Install this project with:

  cd my-project
  npm i

Usage

To run the project, execute the following command:

  npm run dev

Run tests

To run tests, run the following command:

  npm test

Deployment

You can deploy this project using:

    npm run build

   gh-pages deploy --dist build

(back to top)

👥 Authors

👤 RileyManda

• GitHub: @RileyManda
• Twitter: @rilecodez
• LinkedIn: rileymanda

(back to top)

🔭 Future Features

Mobile Version

Implement Media Queries For Mobile Responsiveness

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Show your support 🌟

Thank you for taking the time to explore this project! Your support means a lot to me. If you find my project valuable and would like to contribute, here is one way you can support me:

• Star the project ⭐️: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.

• Fork the project 🍴 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.

• Share with others 🗺️: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.

(back to top)

🙏 Acknowledgments

I would like to express my gratitude to the following individuals and organizations who have contributed to this project and my development journey:

• Microverseinc: I extend my sincere appreciation for their exceptional introductory materials on React and Redux, which served as the foundation for this project.

• Linter and Git Workflows Setup: This project benefited greatly from the setup inspired by Microverseinc's template. I've incorporated it not only into this project but also across all my other projects. It ensures impeccable code quality and precise adherence to syntax standards in CSS, JSX, and JavaScript.

Your contributions have been instrumental in the success of this project, and I'm thankful for the knowledge and resources you've provided.

(back to top)

❓ FAQ

• Question_1

  Do I have to use the vs code specifically?

  • Answer_1

    You can use any code editor of your choice.
    

• Question_2

  Where can I download node JS for installation?

  • Answer_2

  Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. It can be downloaded here.

(back to top)

👥 Attribution

• Original logo design template from: Svgrepo

📝 License

(back to top)