UNPKG

realtimecursor

Version:

Real-time collaboration system with cursor tracking and approval workflow

68 lines (52 loc) • 2.3 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# RealtimeCursor Publishing & Deployment Checklist Use this checklist to ensure you've completed all the necessary steps to make RealtimeCursor available as a library/package. ## SDK Publishing - [ ] Update SDK version in `sdk/package.json` if needed - [ ] Ensure author and other metadata is correct in `sdk/package.json` - [ ] Build the SDK with `cd sdk && npm run build` - [ ] Login to npm with `npm login` - [ ] Publish the SDK with `cd sdk && ./publish.sh` - [ ] Verify the package is available on npm: https://www.npmjs.com/package/realtimecursor-sdk ## Backend Deployment ### Render Deployment - [ ] Push code to GitHub - [ ] Connect Render to GitHub repository - [ ] Configure environment variables in Render - [ ] SUPABASE_URL - [ ] SUPABASE_KEY - [ ] JWT_SECRET - [ ] Deploy using `./deploy.sh render` - [ ] Note the deployed API URL: ______________________ ### Docker Deployment - [ ] Build Docker image with `./deploy.sh docker` - [ ] Configure environment variables - [ ] Run Docker container - [ ] Note the deployed API URL: ______________________ ### Manual Deployment - [ ] Follow instructions in `./deploy.sh manual` - [ ] Note the deployed API URL: ______________________ ## Documentation Update - [ ] Update documentation links with `./update-docs.sh [api_url] [socket_url]` - [ ] Verify links are correct in: - [ ] README.md - [ ] sdk/README.md - [ ] landing/index.html (if exists) - [ ] landing/docs.html (if exists) - [ ] Commit and push updated documentation ## Final Verification - [ ] Test SDK installation from npm in a new project - [ ] Verify backend API is accessible - [ ] Test real-time functionality - [ ] Verify user authentication works - [ ] Check that cursor tracking is functioning ## Marketing & Distribution - [ ] Update website with installation instructions - [ ] Create announcement for social media - [ ] Write blog post about the release - [ ] Notify existing users about the availability ## Notes Use this space for any additional notes or issues encountered during the process: _____________________________________________________________ _____________________________________________________________ _____________________________________________________________ _____________________________________________________________