https://github.com/zerdos/testing.spike.land
https://github.com/zerdos/testing.spike.land
blog deno gatsby monaco monorepo typescript
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zerdos/testing.spike.land
- Owner: zerdos
- License: mit
- Created: 2020-03-26T15:44:25.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2026-01-01T22:28:05.000Z (6 months ago)
- Last Synced: 2026-01-02T07:20:59.876Z (6 months ago)
- Topics: blog, deno, gatsby, monaco, monorepo, typescript
- Language: TypeScript
- Size: 1.63 GB
- Stars: 13
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Real-Time React Page Editor in TypeScript
Easily edit and preview your React pages in real-time using this
TypeScript-based page editor.
[Live Demo](https://spike.land)
## Overview
This project provides a real-time collaborative React page editor built with
TypeScript and powered by Cloudflare Workers. It enables developers to edit and
preview React components in real-time, with built-in collaboration features.
## Documentation
📚 **[View the Documentation Cheatsheet](docs/CHEATSHEET.md)**
### Quick Start
- [Getting Started Guide](docs/development/getting-started.md)
- [Build Process Documentation](docs/development/build-process.md)
### Architecture
- [System Overview](docs/architecture/overview.md)
- [Frontend Architecture](docs/architecture/frontend.md)
- [Workers Architecture](docs/architecture/workers.md)
- [Data Flow](docs/architecture/data-flow.md)
- [State Management](docs/architecture/state-management.md)
## Prerequisites
- Node.js (LTS version)
- Yarn
- Git
## Quick Start
1. Clone the repository:
```bash
git clone https://github.com/zerdos/spike.land.git
cd spike.land
```
2. Install dependencies:
```bash
yarn install
```
3. Start the development environment:
```bash
# Start everything (frontend + workers)
yarn dev
# Or start components individually:
yarn dev:fe # Frontend only
yarn dev:workers # Workers only
```
## Scripts Overview
The project uses a comprehensive build system with the following main commands:
### Development
- `yarn dev` - Start all development servers (frontend + workers)
- `yarn dev:fe` - Start frontend development server only
- `yarn dev:workers` - Start Cloudflare Workers in development mode
### Building
- `yarn build:all` - Build all packages
- `yarn build:fe` - Build frontend only
- `yarn build:workers` - Build workers only
### Deployment
- `yarn deploy:dev` - Deploy to development environment
- `yarn deploy:prod` - Deploy to production environment
### Testing & Utilities
- `yarn test` - Run all tests
- `yarn test:e2e` - Run end-to-end tests
- `yarn lint` - Run linting
- `yarn fmt` - Format code
- `yarn types:check` - Type check all packages
## Monorepo Structure 
This project is organized as a monorepo with the following structure:
```
/packages
├── code/ # Frontend React application
│ ├── dev scripts: # - yarn dev (Vite + TypeScript + Workers)
│ └── build scripts: # - yarn build (Production build with type checking)
│
├── spike.land/ # Main Cloudflare Worker backend
│ ├── dev scripts: # - yarn dev (Local) or yarn dev:remote (Remote)
│ └── deploy scripts: # - yarn deploy:dev/prod (Environment-specific)
│
├── durable-objects/ # Cloudflare Durable Objects for stateful logic
│
├── js.spike.land/ # Transpiler Worker
│ ├── dev scripts: # - yarn dev (Local development)
│ └── deploy scripts: # - yarn deploy:prod (Production deployment)
│
└── spike-land-renderer/ # Page rendering engine
├── dev scripts: # - yarn dev (Local development)
└── deploy scripts: # - yarn deploy (Production deployment)
```
## Development Environment
The project includes several development container configurations in the
`/devcontainers` directory for consistent development environments:
- bookworm-devcontainer
- jammy-devcontainer
- lunar-devcontainer
- trixie-devcontainer
- node-chrome
### Using Gitpod
You can explore the entire repository using Gitpod:
[](https://gitpod.io/#https://github.com/zerdos/spike.land)
After opening in Gitpod, you can access a full Ubuntu + Xfce environment:
```bash
startx # Launches Xfce desktop environment
# Access the remote desktop on port :6080 in your browser
```
## Contributing
Contributions are welcome! Please read our
[Contributing Guidelines](CONTRIBUTING.md) for details on submitting pull
requests.
## License
This project is licensed under the terms of the license found in
[LICENSE.md](LICENSE.md).
## Security
For security concerns, please see our [Security Policy](SECURITY.md).