Skip to content

Commit f2862cd

Browse files
committed
add read me
1 parent 430fe39 commit f2862cd

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# TypeScript Cloud Code
2+
3+
This directory contains TypeScript code that compiles to the `cloud` directory where Parse Server reads cloud code.
4+
5+
## Quick Start
6+
7+
```bash
8+
# Development with auto-compilation and file sync (including deletions)
9+
npm run dev
10+
11+
# One-time build (for commits)
12+
npm run build:cloud-sync
13+
```
14+
15+
## How It Works
16+
17+
- Write TypeScript in `cloud-ts/`
18+
- Files auto-compile to JavaScript in `cloud/`
19+
- When TS files are deleted, JS files are also deleted
20+
21+
## Tips
22+
23+
- Don't edit files in `cloud/` - they'll be overwritten
24+
- New files should be imported in `main.ts`
25+
- Use TypeScript interfaces for Parse objects

0 commit comments

Comments
 (0)