Skip to content

Commit 2dddbe8

Browse files
committed
Update README
1 parent 0595dde commit 2dddbe8

File tree

1 file changed

+81
-3
lines changed

1 file changed

+81
-3
lines changed

README.md

Lines changed: 81 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,48 @@ A CLI tool to bootstrap Skip services with various templates. It provides a quic
1515
To create a new Skip service, run:
1616

1717
```bash
18-
npx create-skip-service <project-name> <options>
18+
npx create-skip-service <project-name> [options]
1919
```
2020

21+
### Options
22+
23+
- `--template <name>` - Use a specific template (default, with_postgres, with_react_vite)
24+
- `--example <name>` - Use an example from the Skip repository
25+
- `--no-git` - Skip git repository initialization
26+
- `--force` - Overwrite existing directory
27+
- `--verbose` - Show detailed output
28+
- `--quiet` - Suppress non-error output
29+
2130
## Available Templates
2231

2332
Templates can be found [here](https://github.com/SkipLabs/create-skip-service/tree/main/templates).
2433

25-
### with-postgres
34+
### default
35+
36+
A basic reactive Skip service template that includes:
37+
38+
- Core Skip service structure
39+
- TypeScript configuration
40+
- Development tools setup
41+
42+
### with_postgres
2643

2744
A template that includes:
2845

2946
- PostgreSQL database integration
30-
- Basic service structure
47+
- Database models and schema
3148
- TypeScript configuration
3249
- Development tools setup
3350

51+
### with_react_vite
52+
53+
A full-stack chat application template that includes:
54+
55+
- React frontend with Vite
56+
- Skip reactive service backend
57+
- Real-time chat functionality
58+
- TypeScript configuration throughout
59+
3460
## Development
3561

3662
To work on this tool locally:
@@ -56,6 +82,58 @@ To work on this tool locally:
5682
- `pnpm dev` - Run in development mode with watch
5783
- `pnpm clean` - Clean build artifacts
5884
- `pnpm format` - Format code with Prettier
85+
- `pnpm test` - Run tests in watch mode
86+
- `pnpm test:run` - Run tests once
87+
- `pnpm test:ui` - Run tests with UI
88+
- `pnpm test:coverage` - Run tests with coverage report
89+
- `pnpm typecheck` - Type checking without emitting
90+
91+
### Testing the CLI locally
92+
93+
```bash
94+
node dist/cli.js <project-name> [options]
95+
```
96+
97+
## Available Examples
98+
99+
You can also bootstrap your project using examples from the Skip repository by using the `--example` flag:
100+
101+
```bash
102+
npx create-skip-service my-project --example <example-name>
103+
```
104+
105+
### blogger
106+
107+
A full-stack blogging platform demonstrating:
108+
109+
- Skip reactive service with leader-follower distributed configuration
110+
- Flask web service for REST API
111+
- Vue.js frontend
112+
- PostgreSQL database
113+
- HAProxy reverse proxy
114+
- Docker Compose and distributed deployment options
115+
116+
### chatroom
117+
118+
A real-time chat application featuring:
119+
120+
- Skip reactive service with Kafka event store
121+
- Express.js web service
122+
- React frontend with real-time messaging
123+
- Docker Compose configuration
124+
- Event-driven architecture demonstration
125+
126+
### hackernews
127+
128+
A HackerNews clone showcasing:
129+
130+
- Skip reactive service with distributed leader-follower setup
131+
- Flask web service with read/write separation
132+
- React frontend with real-time updates
133+
- PostgreSQL database
134+
- HAProxy load balancing
135+
- Both Docker Compose and Kubernetes deployment options
136+
- Comprehensive real-time voting and posting system
59137

60138
## Support
61139

0 commit comments

Comments
 (0)