Skip to content

Commit

Permalink
docs: enhance README with comprehensive project documentation and per…
Browse files Browse the repository at this point in the history
…sonal branding

- Update title and introduction to reflect personal portfolio website
- Add detailed feature descriptions with emojis
- Improve project structure documentation
- Include deployment information
- Add contribution and community sections
- Enhance overall formatting and readability
  • Loading branch information
gr8monk3ys committed Dec 11, 2024
1 parent b7a5b08 commit fbdb55c
Showing 1 changed file with 81 additions and 8 deletions.
89 changes: 81 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,84 @@
## Sidefolio - Portfolio website template
# lscaturchio.xyz – Personal Portfolio and Blog

As seen on [Aceternity UI](https://ui.aceternity.com/templtes/sidefolio)
Welcome to the repository for my personal website, **lscaturchio.xyz**! This project serves as a dynamic platform where I showcase my professional work, share technical insights through blog posts, and engage with the broader tech community.

## Built with
- Next.js
- Tailwindcss
- Framer motion
- MDX
## 🌟 Key Features

Checkout all the templates at [Aceternity UI](https://ui.aceternity.com/templates)
- **🚀 Powered by Next.js 13**: Utilizes the latest version of Next.js for efficient, scalable, and production-ready web applications.
- **💅 Styled with Tailwind CSS**: A utility-first CSS framework ensuring rapid and consistent design implementation.
- **🎨 Interactive Animations**: Smooth, responsive animations created with Framer Motion for an engaging UI.
- **📝 MDX Integration**: Blog posts and content written in MDX, blending Markdown simplicity with React component flexibility.
- **📱 Fully Responsive**: Optimized for all devices, from desktop monitors to smartphones.
- **🎯 SEO-Optimized**: Meta tags, structured data, and best practices ensure improved discoverability on search engines.
- **📄 Dynamic Content**: Modular blog and project pages that can be updated effortlessly.
- **📬 Contact Form**: Enables easy communication with visitors.
- **📑 Resume Section**: A dedicated page to highlight professional achievements and skills.

## 📂 Project Structure

This repository follows a clean and modular structure for ease of navigation and maintainability:

- **`/src/app/*`**: Core application pages and dynamic routing managed by Next.js.
- **`/src/components/*`**: Reusable and customizable UI components to ensure consistency and scalability.
- **`/public/*`**: Static assets such as images, icons, and fonts accessible by the client.
- **`/lib/*`**: Shared utility functions, API integrations, and configuration files.
- **`/fonts/*`**: Custom typography resources to ensure a unique and polished look.

## 🛠️ Built With

This project leverages a modern tech stack to deliver exceptional performance and developer experience:

- **[Next.js 13](https://nextjs.org/)**: The React framework for modern web development, providing server-side rendering, static site generation, and more.
- **[TypeScript](https://www.typescriptlang.org/)**: Ensures strong typing for improved code quality and maintainability.
- **[Tailwind CSS](https://tailwindcss.com/)**: Rapid UI design using a utility-first CSS framework.
- **[Framer Motion](https://www.framer.com/motion/)**: A powerful animation library for creating stunning motion effects.
- **[MDX](https://mdxjs.com/)**: Combines Markdown and JSX for flexible, component-driven content.

## 🚀 Getting Started

Follow these steps to set up and run the project locally:

1. **Clone the Repository**:
```bash
git clone https://github.com/lscaturchio/lscaturchio.xyz.git
cd lscaturchio.xyz
```

2. **Install Dependencies**:
```bash
npm install
# or
yarn install
# or
bun install
```

3. **Run the Development Server**:
```bash
npm run dev
# or
yarn dev
# or
bun dev
```

4. **View in Browser**: Open [http://localhost:3000](http://localhost:3000) to preview the site locally.

## 📈 Deployment

The website is deployed using [Vercel](https://vercel.com/), ensuring rapid and reliable performance with automatic CI/CD pipelines. For production deployment:

1. Connect your GitHub repository to Vercel.
2. Push changes to the `main` branch to trigger an automatic build and deployment.

## 📜 License

This project is open-source and available under the terms of the [MIT License](LICENSE). Contributions and forks are welcome, adhering to the license terms.

## 🙌 Acknowledgments

Special thanks to [Aceternity UI](https://ui.aceternity.com/templates) for inspiring the design aesthetics of this website.

---

By contributing to or using this project, you’re joining a journey toward fostering creativity and innovation in the tech community. Feel free to explore, contribute, or reach out for collaboration opportunities! 🚀

0 comments on commit fbdb55c

Please sign in to comment.