Skip to content

Commit 1e4ef92

Browse files
committed
Updated readme and deployment port
1 parent 4142649 commit 1e4ef92

File tree

2 files changed

+81
-2
lines changed

2 files changed

+81
-2
lines changed

.github/workflows/build-push-deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ jobs:
185185
image: "${IMAGE_WITH_TAG}"
186186
container_name: codesark
187187
ports:
188-
- "8080:3000"
188+
- "8081:3000"
189189
environment:
190190
- NODE_ENV=production
191191
env_file:

README.md

Lines changed: 80 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,84 @@
11

2+
# CodeSark Portfolio
3+
24
[![Build + Push + Deploy](https://github.com/codesark/codesark-portfolio/actions/workflows/build-push-deploy.yml/badge.svg)](https://github.com/codesark/codesark-portfolio/actions/workflows/build-push-deploy.yml)
35

4-
# CodeSark Portfolio Next
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
30+
31+
### Prerequisites
32+
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
584

0 commit comments

Comments
 (0)