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

https://github.com/lilithcode/space-portfolio


https://github.com/lilithcode/space-portfolio

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# Space-Themed Portfolio

Welcome to my space-themed portfolio! This project showcases my skills, projects, and contact information in a visually stunning interactive **3D environment** using **React, Three.js, and Vite**.

## 📌 Table of Contents
1️⃣ [Demo](#-demo)
2️⃣ [Features](#-features)
3️⃣ [Technologies Used](#-technologies-used)
4️⃣ [Installation](#-installation)
5️⃣ [Usage](#-usage)
6️⃣ [Project Structure](#-project-structure)
7️⃣ [Environment Variables](#-environment-variables)
8️⃣ [Contributing](#-contributing)
9️⃣ [License](#-license)

---

## 🎮 Demo
🔗 Check out the live demo: [Full Stack Developer | Hamna .dev](https://spacetheme-portfolio-4cgq7erc4-liliths-projects-ac0f877a.vercel.app/)

---

## ✨ Features
✅ Interactive 3D environment with rotating stars & planets
✅ Smooth Navigation (About, Projects, Skills & Contact)
✅ Fluid Animations & Transitions
✅ Fully Responsive Design
✅ Functional Contact Form with EmailJS

---

## 🛠️ Technologies Used
- **React**: JavaScript library for UI development
- **Three.js**: JavaScript 3D library
- **@react-three/fiber**: React renderer for Three.js
- **@react-three/drei**: Helpers for Three.js
- **Vite**: Next-gen frontend tooling
- **Tailwind CSS**: Utility-first CSS framework
- **EmailJS**: Service to send emails directly from the client-side

---

## 📥 Installation

1. Clone the repository:
```sh
git clone https://github.com/lilithCode/Portfolio.git
cd portfolio
```

2. Install the dependencies:
```sh
npm install
```

3. Create a `.env` file in the root of the project and add your EmailJS credentials:
```env
VITE_APP_EMAILJS_SERVICE_ID=your_service_id
VITE_APP_EMAILJS_TEMPLATE_ID=your_template_id
VITE_APP_EMAILJS_PUBLIC_KEY=your_public_key
```

## 🚀 Usage

### Start development server
```bash
npm run dev
```
This will launch the project at **localhost:5173** _(or another available port)_.

### Build for production
```bash
npm run build
```

### Preview production build locally
```bash
npm run preview
```

---

## Contributing

Contributions are welcome! If you have any suggestions or improvements, feel free to open an issue or submit a pull request.

---