Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sachinraja/trpc-rakkas
tRPC in Rakkas
https://github.com/sachinraja/trpc-rakkas
rakkas trpc vite
Last synced: 23 days ago
JSON representation
tRPC in Rakkas
- Host: GitHub
- URL: https://github.com/sachinraja/trpc-rakkas
- Owner: sachinraja
- License: mit
- Created: 2022-03-27T07:46:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-03-27T15:36:13.000Z (over 2 years ago)
- Last Synced: 2024-10-04T19:22:29.234Z (about 1 month ago)
- Topics: rakkas, trpc, vite
- Language: TypeScript
- Homepage: https://trpc-rakkas.vercel.app
- Size: 49.8 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tRPC Rakkas Starter
[tRPC Docs](https://trpc.io/)
[Rakkas Docs](https://rakkasjs.org/)
## Quick start
```sh
# Start development server on localhost:3000
npm run dev
# Start a development server on port 4000 and make it externally accessible
npm run dev -- --host=0.0.0.0 --port=4000
# Build a production server
npm run build
# Start production server on 0.0.0.0:3000
# and trust x-forwarded-* headers set by your reverse proxy
HOST=0.0.0.0 PORT=3000 TRUST_FORWARDED_ORIGIN=1 npm start
```
## Important files and directories
| Path | Description |
| ------------------ | --------------------------------------------- |
| `rakkas.config.ts` | Rakkas configuration |
| `public` | Static files to be served from `/` |
| `src/client.ts` | Client-side cusomization hooks |
| `src/server.ts` | Server-side customization hooks |
| `src/pages` | Pages and layouts (client-side routes) |
| `src/api` | Endpoints and middleware (server-side routes) |
| `src/ambient.d.ts` | Ambient type declarations |
## All development scripts
Some of them might not be available depending on the features you selected when generating his project.
| Script | Description |
| -------------------------- | ------------------------------------------------------- |
| `npm run dev` | Start development server on localhost:3000 |
| `npm run build` | Build a production server |
| `npm start` | Start the production server |
| `npm run check` | Run all checks (linters, typecheckers, tests) |
| `npm test` | Run all tests |
| `npm run test:unit` | Run unit tests |
| `npm run test:e2e` | Start the server and run end-to-end tests (build first) |
| `npm run test:e2e:api` | Run end-to-end API tests (start the server first) |
| `npm run test:e2e:browser` | Run end-to-end browser tests (start the server first) |
| `npm run typecheck` | Check the types |
| `npm run lint` | Run all linters |
| `npm run lint:ts` | Lint TypeScript files |
| `npm run lint:css` | Lint CSS files |
| `npm run format` | Format source files with Prettier |