https://github.com/marco-souza/marco.pages.dev
Honox version of my Personal web site
https://github.com/marco-souza/marco.pages.dev
biomejs bun cloudflare cloudflare-pages cloudflare-workers daisyui github-actions hono honox htmx jsx lefthook playwright tailwindcss vite vitest
Last synced: 3 months ago
JSON representation
Honox version of my Personal web site
- Host: GitHub
- URL: https://github.com/marco-souza/marco.pages.dev
- Owner: marco-souza
- Created: 2025-01-16T20:31:33.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-03-25T15:55:04.000Z (3 months ago)
- Last Synced: 2025-03-25T16:24:50.137Z (3 months ago)
- Topics: biomejs, bun, cloudflare, cloudflare-pages, cloudflare-workers, daisyui, github-actions, hono, honox, htmx, jsx, lefthook, playwright, tailwindcss, vite, vitest
- Language: TypeScript
- Homepage: https://marco-pages-dev.pages.dev
- Size: 626 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Marco's ~overengineered~ Personal Site
Welcome to the repository for my ~overengineered~ personal site, hosted on Cloudflare Pages. This project is built using a modern development stack to ensure a seamless and efficient development and deployment experience.
## Features 🚀
- **Modern Development Stack**: Built with [Vite](https://vitejs.dev/) ⚡ for fast builds and hot module replacement, [Tailwind CSS](https://tailwindcss.com/) 🎨 for utility-first styling, and [Wrangler](https://developers.cloudflare.com/workers/wrangler/) 🛠️ for managing Cloudflare Workers.
- **Seamless Deployment**: Deploy the site to [Cloudflare Pages](https://pages.cloudflare.com/) effortlessly with a single command. 🌐
- **TypeScript Support**: Full support for [TypeScript](https://www.typescriptlang.org/) 🦾, providing type safety and enhancing the developer experience.
- **Environment Management**: Securely manage environment variables and secrets using Wrangler 🔐.
- **Automated Testing**: Includes a test suite powered by [Vitest](https://vitest.dev/) 🧪 to maintain code quality.
- **Code Quality Tools**: Integrated with [Biome](https://biome.dev/) 🧹 for code formatting and linting to keep the codebase clean.
- **End-to-End Testing**: Utilizes [Playwright](https://playwright.dev/) 🎭 for comprehensive end-to-end testing.
- **Preview and Debugging**: Preview the site locally and debug using Wrangler's preview feature 🔍.
- **Extensible**: Easily extendable with additional plugins and configurations to meet various project needs. 🔧
- **Unconventional Setup**: We're using JSX + [htmx](https://htmx.org/) 💡, an unconventional yet powerful combination for building dynamic UIs.
## Installation
To get started with this project, clone the repository and install the dependencies:
```bash
git clone https://github.com/marco-souza/marco.pages.dev.git
cd marco.pages.dev
bun install
```
## Usage
### Development
To start the development server, run:
```bash
bun run dev
```
This will start a local development server with hot-reloading enabled.
### Deployment
To deploy the site to Cloudflare Pages, use:
```bash
bun run deploy
```
## Scripts
- `dev`: Starts the Vite development server.
- `tests`: Runs the test suite using Vitest.
- `build`: Builds the site for production.
- `e2e`: Runs end-to-end tests using Playwright.
- `fmt`: Formats the code using Biome.
- `lint`: Lints the codebase and fixes issues.
- `postinstall`: Runs post-installation scripts.
- `w`: Alias for Wrangler commands.
- `w:secret`: Manages secrets for Cloudflare Pages.
- `w:typegen`: Generates types for Wrangler.
- `preview`: Previews the site using Wrangler.
- `deploy`: Builds and deploys the site.
## Contributing
Contributions are welcome! Please fork the repository and submit a pull request for any improvements or bug fixes.
## License
This project is licensed under the MIT License.
---
### Reference
This project was initially based on the Honox Cloudflare Template, which provides a robust foundation for deploying applications using modern tools like Vite, Tailwind CSS, and Wrangler.
**Links**
- https://github.com/honojs/honox
- https://github.com/marco-souza/honox-cloudflare-template