Sendyka.dev Personal Site

Personal portfolio and blog site for sendyka.dev

Project ready to deploy on Github Pages and Cloudflare Pages

🛠️ Tech Stack

This project is built using:

• Framework: React 18 with Vite
• Routing: React Router DOM
• Styling: Tailwind CSS with shadcn/ui
• Theme Handling: shadcn-ui
• Content Processing:
  • Markdown processing with unified
  • Various remark/rehype plugins for content enhancement
• UI Components:
  • Radix UI primitives
  • Lucide icons
  • Embla Carousel
  • React Day Picker

🚀 Getting Started

1. Clone the repository

git clone https://github.com/yourusername/sendyka.dev-site.git
cd sendyka.dev-site

2. Install dependencies

npm install
# or
yarn
# or
pnpm install
# or
bun install

3. Run the development server

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

4. Open http://localhost:8080 in your browser

🌐 Deployment

For live hosting services, I use Cloudflare Pages due to its reliability, performance, and ease of use. Previously, I used GitHub Pages through the Student Pack, then Netlify, but moved everything to Cloudflare to centralize services.

Deployment to Cloudflare Pages

This project is configured to be deployed to Cloudflare Pages.

Important Notes

• Cloudflare Pages runs bun install --frozen-lockfile by default
• We use cloudflare-pages.toml to override the default build command
• Always commit the bun.lockb file to your repository
• Before deploying, run bun install locally to ensure the lockfile is up to date

Deployment Steps

1. Push changes to the main branch
2. Cloudflare Pages will automatically deploy the site
3. If you encounter any issues with the lockfile, run bun install locally and commit the updated bun.lockb file

Self-Hosted Deployment Options

This project includes multiple options for deploying on your own server:

Option 1: Deployment with Nixpacks

This project includes a nixpacks.toml configuration file for deploying on self-hosted servers using Nixpacks.

Prerequisites

• Docker installed on your server
• Nixpacks installed
• Git access to clone the repository

Deployment Steps

1. Clone the repository on your server

   git clone https://github.com/yourusername/sendyka.dev-site.git
   cd sendyka.dev-site

2. Build the Docker image using Nixpacks

   nixpacks build . -n sendyka-dev-site

3. Run the container

   docker run -p 3000:3000 sendyka-dev-site

4. Access your site at http://your-server-ip:3000

Option 2: Using Docker Directly

This project includes a Dockerfile for direct Docker builds.

Deployment Steps

1. Clone the repository

   git clone https://github.com/yourusername/sendyka.dev-site.git
   cd sendyka.dev-site

2. Build the Docker image

   docker build -t sendyka-dev-site .

3. Run the container

   docker run -p 3000:3000 sendyka-dev-site

Option 3: Using Docker Compose

For the easiest deployment, use the included Docker Compose file.

Deployment Steps

1. Clone the repository

   git clone https://github.com/yourusername/sendyka.dev-site.git
   cd sendyka.dev-site

2. Create a .env file with your environment variables (optional)

   echo "NEXT_PUBLIC_BASE_URL=https://your-domain.com" > .env
   echo "NEXT_PUBLIC_SITE_URL=https://your-domain.com" >> .env

3. Start the service

   docker-compose up -d

4. Access your site at http://your-server-ip:3000

Local Development

# Install dependencies
npm install

# Run development server
npm run dev

# Build for production
npm run build

🤝 Contribution

Feel free to check the code, fork it, and use what you need for your own projects. If you'd like to contribute:

1. Fork the repository
2. Create a new branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Commit your changes (git commit -m 'Add some amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a Pull Request

📝 License

This project is available for free use and modification for personal or commercial purposes. Attribution is appreciated but not required.