-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Update 'README.md' with documentation
- Loading branch information
Showing
1 changed file
with
189 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,189 @@ | ||
# top-s | ||
### A detailed description will be available shortly.✨😁 | ||
<a name="readme-top"></a> | ||
|
||
<div align="center"> | ||
<img src="/public/reactive-portfolio-favicon.png" alt="logo" width="320" height="auto" /> | ||
<h1><b>⚛️ ITurres | Reactive Portfolio ⚛️</b></h1> | ||
</div> | ||
|
||
--- | ||
|
||
<!-- * TABLE OF CONTENTS --> | ||
|
||
# 📗 Table of Contents | ||
|
||
- [📖 About the Project](#about-project) | ||
- [🛠 Built With](#built-with) | ||
- [Tech Stack](#tech-stack) | ||
- [🚀 Live Demo](#live-demo) | ||
- [💻 Getting Started](#getting-started) | ||
- [Setup](#setup) | ||
- [Prerequisites](#prerequisites) | ||
- [Install](#install) | ||
- [👥 Authors](#authors) | ||
- [🤝 Contributing](#contributing) | ||
- [⭐️ Show your support](#support) | ||
|
||
--- | ||
|
||
<!-- * PROJECT DESCRIPTION --> | ||
|
||
# 📖 Reactive Portfolio <a name="about-project"></a> | ||
|
||
- 💼 Welcome to my 2023 ⚛️Reactive portfolio⚛️, where I proudly present a collection of projects I've diligently worked on from 2022 until today. Feel free to explore these endeavors and witness the evolution of my skills and creativity. If you're interested in learning more about my background and experience, you can find my resume on the **about page** of the portfolio. For any inquiries or collaboration opportunities, please don't hesitate to reach out through the contact form on the **contact page**. I'm excited to share my journey with you and look forward to connecting! | ||
|
||
--- | ||
|
||
## 🛠 Built With <a name="built-with"></a> | ||
|
||
### Tech Stack <a name="tech-stack"></a> | ||
|
||
<ul> | ||
<li> | ||
<a href="https://react.dev/"> | ||
<img src="https://skillicons.dev/icons?i=react"/> | ||
React.ts | ||
</a> | ||
</li> | ||
<li> | ||
<a href="https://www.typescriptlang.org/"> | ||
<img src="https://skillicons.dev/icons?i=ts"/> | ||
TypeScript | ||
</a> | ||
</li> | ||
<li> | ||
<a href="https://sass-lang.com/"> | ||
<img src="https://skillicons.dev/icons?i=scss"/> | ||
SASS | ||
</a> | ||
</li> | ||
<li> | ||
<a href="https://developer.mozilla.org/en-US/docs/Web/HTML"> | ||
<img src="https://skillicons.dev/icons?i=html"/> | ||
HTML | ||
</a> | ||
</li> | ||
</ul> | ||
|
||
### Libraries used: | ||
|
||
- #### [Splide.js](https://splidejs.com/) | ||
- #### [React Router](https://reactrouter.com/) | ||
- #### [React Icons](https://react-icons.github.io/react-icons/) | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
--- | ||
|
||
<!-- * LIVE DEMO --> | ||
|
||
## 🚀 Live Demo <a name="live-demo"></a> | ||
|
||
- [ITurres Reactive Portfolio 👨🚀 - Live Demo Link](https://iturres.github.io/iturres-reactive-portfolio/) | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
--- | ||
|
||
<!-- * GETTING STARTED --> | ||
|
||
## 💻 Getting Started <a name="getting-started"></a> | ||
|
||
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: | ||
|
||
Example commands: | ||
|
||
- With SSH: | ||
|
||
```bash | ||
cd your-folder | ||
git clone [email protected]:ITurres/iturres-reactive-portfolio.git | ||
``` | ||
|
||
- With HTTPS: | ||
|
||
```bash | ||
cd your-folder | ||
git clone https://github.com/ITurres/iturres-reactive-portfolio.git | ||
``` | ||
|
||
- With GitHub CLI: | ||
|
||
```bash | ||
cd your-folder | ||
gh repo clone ITurres/iturres-reactive-portfolio | ||
``` | ||
|
||
### Install | ||
|
||
Install this project's dependencies with: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
### Usage | ||
|
||
To run the project, execute the following command: | ||
|
||
```bash | ||
npm start | ||
``` | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
--- | ||
|
||
<!-- * AUTHORS --> | ||
|
||
## 👥 Authors <a name="authors"></a> | ||
|
||
👤 **Arthur Iturres** | ||
|
||
- GitHub: [@ITurres](https://github.com/ITurres) | ||
- LinkedIn: [Arthur Emanuel G. Iturres](https://www.linkedin.com/in/arturoemanuelguerraiturres/) | ||
- Angellist / Wellfound: [Arturo (Arthur) Emanuel Guerra Iturres](https://wellfound.com/u/arturo-arthur-emanuel-guerra-iturres) | ||
- Youtube: [Arturo Emanuel Guerra Iturres - Youtube Channel](https://www.youtube.com/channel/UC6GFUFHOtBS9mOuI8EJ6q4g) | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
--- | ||
|
||
<!-- * CONTRIBUTING --> | ||
|
||
## 🤝 Contributing <a name="contributing"></a> | ||
|
||
Contributions, issues, and feature requests are welcome! | ||
|
||
Feel free to check the [issues page](https://github.com/ITurres/iturres-reactive-portfolio/issues). | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
--- | ||
|
||
<!-- * SUPPORT --> | ||
|
||
## ⭐️ Show your support <a name="support"></a> | ||
|
||
Give a ⭐ if you liked this project! | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
--- | ||
|
||
<!-- * LICENSE --> | ||
|
||
## 📝 License <a name="license"></a> | ||
|
||
This project is [MIT](./LICENSE) licensed. | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
--- |