Skip to content

Commit f63b5c3

Browse files
authored
Update README.md
1 parent 3c7553b commit f63b5c3

File tree

1 file changed

+104
-20
lines changed

1 file changed

+104
-20
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 104 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,120 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
# 🌟 Jesus Torres: Portfolio Project
22

3-
## Getting Started
3+
Welcome to my portfolio project! This is a cutting-edge **Next.js** application showcasing my skills, projects, and experience. πŸš€ Built with a blend of modern frameworks and tools, the portfolio serves as a central hub for my professional journey and creative work.
44

5-
First, run the development server:
5+
---
66

7+
## ✨ Project Overview
8+
This portfolio is designed to:
9+
- 🌐 Highlight my recent projects and professional experience.
10+
- 🎨 Provide a sleek, interactive design with responsive layouts.
11+
- πŸ” Incorporate dynamic elements for an engaging user experience.
12+
13+
---
14+
15+
## 🌐 Live Website
16+
Check out the live website here: [Portfolio Website](https://mango-pebble-08050a31e.4.azurestaticapps.net/) 🌍
17+
18+
---
19+
20+
## πŸ“š Key Features
21+
22+
- **Modern Design**: Powered by **Tailwind CSS**, the portfolio boasts a clean and responsive user interface.
23+
- **Dynamic Navigation**: Features a floating navigation bar built with **Framer Motion** for smooth animations.
24+
- **3D Visualizations**: Integrates **Three.js** and **@react-three/fiber** for immersive 3D elements.
25+
- **Theme Switching**: Supports light and dark mode with **next-themes** for user personalization.
26+
- **Error Monitoring**: Uses **Sentry** for tracking and fixing errors seamlessly.
27+
28+
---
29+
30+
## πŸ› οΈ Technologies Used
31+
32+
Here are the main technologies and libraries powering this portfolio:
33+
34+
### Core Frameworks
35+
- **Next.js** 🌟
36+
- **React** βš›οΈ
37+
38+
### Styling & Animations
39+
- **Tailwind CSS** 🎨
40+
- **Framer Motion** πŸŽ₯
41+
42+
### 3D Graphics
43+
- **Three.js** 🌌
44+
- **@react-three/fiber** πŸ› οΈ
45+
46+
### Utility Libraries
47+
- **clsx** πŸ› οΈ
48+
- **tailwind-merge** πŸ”€
49+
- **postcss** πŸ’…
50+
51+
### Development Tools
52+
- **TypeScript** πŸ’»
53+
- **ESLint** 🧐
54+
55+
### Monitoring
56+
- **@sentry/nextjs** πŸ›‘οΈ
57+
58+
---
59+
60+
## πŸ› οΈ Installation & Setup
61+
62+
To run this project locally, follow these steps:
63+
64+
### 1. Clone the Repository
65+
```bash
66+
git clone https://github.com/username/portfolio.git
67+
```
68+
69+
### 2. Install Dependencies
70+
```bash
71+
npm install
72+
```
73+
74+
### 3. Start the Development Server
775
```bash
876
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
1577
```
1678

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
79+
### 4. Open in Browser
80+
Navigate to [http://localhost:3000](http://localhost:3000) to view the application.
81+
82+
---
83+
84+
## πŸ”§ Configuration
85+
86+
### Environment Variables
87+
To enable error monitoring and other advanced features, set up the following environment variables:
88+
- `NEXT_PUBLIC_SENTRY_DSN`: Your Sentry Data Source Name.
89+
- `NEXT_PUBLIC_API_URL`: The base API URL (if applicable).
90+
91+
### Deployment Options
92+
93+
#### Azure Static Web Apps 🌐
94+
This portfolio is live on Azure Static Web Apps for seamless global availability.
95+
96+
#### GitHub Pages πŸ–₯️
97+
Also configured for deployment via GitHub Pages to ensure redundancy.
1898

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
99+
---
20100

21-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
101+
## πŸš€ Future Improvements
22102

23-
## Learn More
103+
Some planned enhancements include:
104+
- 🌟 Adding more 3D visualizations.
105+
- πŸ“ˆ Expanding project case studies.
106+
- πŸ”’ Implementing advanced security features.
24107

25-
To learn more about Next.js, take a look at the following resources:
108+
---
26109

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
110+
## 🀝 Contributions
111+
This project is personal but open to constructive feedback! Feel free to fork, star ⭐, or create an issue for suggestions.
29112

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
113+
---
31114

32-
## Deploy on Vercel
115+
### πŸ“§ Contact Me
116+
If you'd like to connect, reach out via email or check out my social media profiles on the site.
33117

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
118+
---
35119

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
120+
Built with ❀️ using **Next.js**, **Tailwind**, and a passion for creativity!

0 commit comments

Comments
Β (0)