@touchless/exo v0.0.1

Gen-4

This project leverages Cloudflare Workers, Hono, Websockets, Durable Objects, D1, KV and Vite to create a dynamic edge-first rendered application. This README provides a brief overview of the project setup, development, and deployment processes.

Table of Contents

• Prerequisites
• Setup
• Development
• Building
• Deployment
• Testing
• Contributing
• License

Prerequisites

• Node.js 18.12.1 or higher and yarn
• A Cloudflare account and wrangler CLI installed globally or use the local version from node_modules

Setup

1. Clone the repository:

`bash git clone https://github.com/touchlesscode/exo-gen4 `

2. Install dependencies:

`bash yarn install `

Development

To start the local development server:

`bash yarn run dev `

Building

To build the client:

`bash yarn run build:client `

To build the Cloudflare Worker:

`bash yarn run build:worker `

To build both:

`bash yarn run build `

Deployment

Deploy the built Cloudflare Worker:

`bash yarn run deploy:dev `

Ensure that your wrangler.toml is correctly configured for the appropriate account, zone, and route.

Testing

Run tests:

`bash yarn run dev yarn run test `

Run tests in watch mode:

`bash yarn run test:watch `

Generate test coverage:

`bash yarn run test:coverage `

Contributing

For major changes, please open an issue first to discuss what you would like to change.

Ensure to update tests as appropriate. Expected test coverage is 100% of all key components.

License

Internal use for Touchless Inc. only. All rights reserved.