https://github.com/beenotung/create-rpc
Starter template of Typescript web server with auto-generated client SDK using RPC with ajax.
https://github.com/beenotung/create-rpc
code-generation rpc-client rpc-server starter-kit starter-template typescript-boilerplate
Last synced: 4 months ago
JSON representation
Starter template of Typescript web server with auto-generated client SDK using RPC with ajax.
- Host: GitHub
- URL: https://github.com/beenotung/create-rpc
- Owner: beenotung
- License: bsd-2-clause
- Created: 2023-03-26T15:08:33.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-09T19:57:44.000Z (about 1 year ago)
- Last Synced: 2024-05-13T16:41:17.037Z (about 1 year ago)
- Topics: code-generation, rpc-client, rpc-server, starter-kit, starter-template, typescript-boilerplate
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/create-rpc
- Size: 166 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# create-rpc
Starter template of Typescript web server with auto-generated client SDK using RPC with ajax.
[](https://www.npmjs.com/package/create-rpc)
## Usage
Interactive mode:
```bash
npm init rpc
# or
npx create-rpc
```
Non-interactive mode:
```bash
npx -y create-rpc --single [project-name]
# or
npx -y create-rpc --multi [project-name]
# or
npx -y create-rpc --restful [project-name]
```
## Template Features
- Auto-generate standalone[1] client SDK in Typescript
- Infer input/output type from sample data or [cast.ts](https://github.com/beenotung/cast.ts) parser
- Auto apply runtime type checking on input/output data
- Auto-generate (knex) database migration with quick-erd
- Typed array-like ORM with better-sqlite3-proxy
- Hashing password with bcrypt
- JWT generation
- Auto-storing JWT token
- Dotenv setup
- Multiple templates
- single module API
- multi module API
- restful API
[1]: The generated client sdk is self-contained. You don't need to import the server from the client project.
## Available Commands
Inside the server directory, you can run several commands:
```
npm start
Starts the auto-refresh development server.
[single module] It auto generates the client/src/sdk.ts based on the APIs defined in server/src/core.ts.
[multi module] It auto generates the client/src/api/[name].ts based on the APIs defined in server/src/modules/[name].ts.
[restful] It auto generates the client/src/api/[name].ts based on the APIs defined in server/src/modules/[name].ts.
npm run db:setup
Migrate the database schema to latest version.
npm run db:plan
Auto-generate migration based on erd.txt and current database schema.
npm run db:update
Apply the new migration plan, and update the proxy.ts based on the erd.txt.
npm run db:seed
Populate the database with sample data in server/seed.ts.
npm run build
Builds the web project into 'dist' folder.
```
## License
This project is licensed with [BSD-2-Clause](./LICENSE)
This is free, libre, and open-source software. It comes down to four essential freedoms [[ref]](https://seirdy.one/2021/01/27/whatsapp-and-the-domestication-of-users.html#fnref:2):
- The freedom to run the program as you wish, for any purpose
- The freedom to study how the program works, and change it so it does your computing as you wish
- The freedom to redistribute copies so you can help others
- The freedom to distribute copies of your modified versions to others