|
1 | 1 |
|
2 | 2 | # CodeSark Portfolio |
3 | 3 |
|
4 | | -[](https://github.com/codesark/codesark-portfolio/actions/workflows/build-push-deploy.yml) |
5 | | - |
6 | | -A modern, responsive portfolio website built with Next.js, TypeScript, and Tailwind CSS. Features a clean design with sections for projects, skills, and contact information. |
7 | | - |
8 | | -## Features |
9 | | - |
10 | | -- 🎨 Modern UI with Tailwind CSS and Framer Motion animations |
11 | | -- 📱 Fully responsive design |
12 | | -- 🚀 Server-side rendering with Next.js |
13 | | -- 📧 Contact form with email integration |
14 | | -- 🎯 Skills and project showcase |
15 | | -- 🔄 CI/CD with GitHub Actions |
16 | | -- 🐳 Containerized with Docker |
17 | | - |
18 | | -## Tech Stack |
19 | | - |
20 | | -- **Framework:** Next.js 14 |
21 | | -- **Language:** TypeScript |
22 | | -- **Styling:** Tailwind CSS |
23 | | -- **Animations:** Framer Motion |
24 | | -- **UI Components:** Radix UI |
25 | | -- **Email Service:** Nodemailer |
26 | | -- **Deployment:** Docker |
27 | | -- **CI/CD:** GitHub Actions |
28 | | - |
29 | | -## Development |
| 4 | +[](https://github.com/codesark/codesark.dev/actions/workflows/build-push-deploy.yml) |
| 5 | +[](https://nextjs.org/) |
| 6 | +[](https://www.typescriptlang.org/) |
| 7 | +[](https://tailwindcss.com/) |
| 8 | + |
| 9 | +A modern, responsive portfolio website showcasing my professional work and skills. Built with cutting-edge technologies, this portfolio features a clean design, smooth animations, and seamless user experience. |
| 10 | + |
| 11 | +## ✨ Features |
| 12 | + |
| 13 | +- 🎨 **Modern UI Design** |
| 14 | + - Sleek interface with Tailwind CSS |
| 15 | + - Smooth animations powered by Framer Motion |
| 16 | + - Responsive layout for all devices |
| 17 | + |
| 18 | +- 🚀 **Advanced Technology** |
| 19 | + - Server-side rendering with Next.js 14 |
| 20 | + - Type-safe development with TypeScript |
| 21 | + - Component-driven UI with Radix UI |
| 22 | + |
| 23 | +- 📧 **Interactive Elements** |
| 24 | + - Fully functional contact form |
| 25 | + - Email integration with Nodemailer |
| 26 | + - Real-time form validation |
| 27 | + |
| 28 | +- 🔄 **DevOps Integration** |
| 29 | + - Automated CI/CD with GitHub Actions |
| 30 | + - Containerized deployment with Docker |
| 31 | + - Optimized build process |
| 32 | + |
| 33 | +## 🛠️ Tech Stack |
| 34 | + |
| 35 | +- **Frontend Framework:** Next.js 14 |
| 36 | +- **Language:** TypeScript 5 |
| 37 | +- **Styling:** |
| 38 | + - Tailwind CSS 3 |
| 39 | + - Framer Motion for animations |
| 40 | +- **UI Components:** |
| 41 | + - Radix UI for accessible components |
| 42 | + - Custom styled components |
| 43 | +- **Backend Services:** |
| 44 | + - Nodemailer for email handling |
| 45 | + - Server-side API routes |
| 46 | +- **DevOps:** |
| 47 | + - Docker for containerization |
| 48 | + - GitHub Actions for CI/CD |
| 49 | + - Automated testing and deployment |
| 50 | + |
| 51 | +## 🚀 Development |
30 | 52 |
|
31 | 53 | ### Prerequisites |
32 | 54 |
|
33 | | -- Node.js 20.x |
34 | | -- npm or yarn |
35 | | - |
36 | | -### Installation |
37 | | - |
38 | | -1. Clone the repository |
39 | | -```bash |
40 | | -git clone https://github.com/codesark/codesark-portfolio.git |
41 | | -cd codesark-portfolio |
42 | | -``` |
43 | | - |
44 | | -2. Install dependencies |
45 | | -```bash |
46 | | -npm install |
47 | | -# or |
48 | | -yarn install |
49 | | -``` |
50 | | - |
51 | | -3. Create a `.env` file in the root directory with the following variables: |
52 | | -```env |
53 | | -SMTP_HOST=your_smtp_host |
54 | | -SMTP_PORT=your_smtp_port |
55 | | -SMTP_USER=your_smtp_user |
56 | | -SMTP_PASS=your_smtp_password |
57 | | -SMTP_FROM=your_from_email |
58 | | -SMTP_TO=your_to_email |
59 | | -SMTP_SECURE=true_or_false |
60 | | -``` |
61 | | - |
62 | | -4. Start the development server |
63 | | -```bash |
64 | | -npm run dev |
65 | | -# or |
66 | | -yarn dev |
67 | | -``` |
68 | | - |
69 | | -## Docker Deployment |
70 | | - |
71 | | -1. Build the Docker image |
72 | | -```bash |
73 | | -docker build -t codesark-portfolio . |
74 | | -``` |
75 | | - |
76 | | -2. Run the container |
77 | | -```bash |
78 | | -docker run -p 3000:3000 --env-file .env codesark-portfolio |
79 | | -``` |
80 | | - |
81 | | -## License |
82 | | - |
83 | | -MIT License |
| 55 | +- Node.js 20.x or higher |
| 56 | +- npm or yarn package manager |
| 57 | +- Git |
| 58 | + |
| 59 | +### Getting Started |
| 60 | + |
| 61 | +1. **Clone the repository** |
| 62 | + ```bash |
| 63 | + git clone https://github.com/codesark/codesark.dev.git |
| 64 | + cd codesark.dev |
| 65 | + ``` |
| 66 | + |
| 67 | +2. **Install dependencies** |
| 68 | + ```bash |
| 69 | + npm install |
| 70 | + # or |
| 71 | + yarn install |
| 72 | + ``` |
| 73 | + |
| 74 | +3. **Configure environment variables** |
| 75 | + Create a `.env` file in the root directory with the following variables: |
| 76 | + ```env |
| 77 | + # SMTP Configuration |
| 78 | + SMTP_HOST=your_smtp_host |
| 79 | + SMTP_PORT=your_smtp_port |
| 80 | + SMTP_USER=your_smtp_user |
| 81 | + SMTP_PASS=your_smtp_password |
| 82 | + SMTP_FROM=your_from_email |
| 83 | + SMTP_TO=your_to_email |
| 84 | + SMTP_SECURE=true_or_false |
| 85 | + ``` |
| 86 | + |
| 87 | +4. **Start development server** |
| 88 | + ```bash |
| 89 | + npm run dev |
| 90 | + # or |
| 91 | + yarn dev |
| 92 | + ``` |
| 93 | + The application will be available at `http://localhost:3000` |
| 94 | + |
| 95 | +## 🐳 Docker Deployment |
| 96 | + |
| 97 | +### Local Deployment |
| 98 | + |
| 99 | +1. **Build the Docker image** |
| 100 | + ```bash |
| 101 | + docker build -t codesark-portfolio . |
| 102 | + ``` |
| 103 | + |
| 104 | +2. **Run the container** |
| 105 | + ```bash |
| 106 | + docker run -p 3000:3000 --env-file .env codesark-portfolio |
| 107 | + ``` |
| 108 | + |
| 109 | +### Production Deployment |
| 110 | + |
| 111 | +1. **Build optimized image** |
| 112 | + ```bash |
| 113 | + docker build --build-arg NODE_ENV=production -t codesark-portfolio:prod . |
| 114 | + ``` |
| 115 | + |
| 116 | +2. **Run in production mode** |
| 117 | + ```bash |
| 118 | + docker run -d -p 3000:3000 --env-file .env --restart unless-stopped codesark-portfolio:prod |
| 119 | + ``` |
| 120 | + |
| 121 | +## 📝 License |
| 122 | + |
| 123 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
| 124 | + |
| 125 | +--- |
| 126 | + |
| 127 | +© 2024 CodeSark. All rights reserved. |
84 | 128 |
|
0 commit comments