Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kitajs/minimal-example
📪 A KitaJS boilerplate with the smallest possible number of files.
https://github.com/kitajs/minimal-example
docs endpoint example getting js kita kitajs minimal rest started typescript
Last synced: about 1 month ago
JSON representation
📪 A KitaJS boilerplate with the smallest possible number of files.
- Host: GitHub
- URL: https://github.com/kitajs/minimal-example
- Owner: kitajs
- License: mit
- Created: 2023-10-10T03:17:11.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-31T20:13:57.000Z (9 months ago)
- Last Synced: 2024-03-31T21:22:33.925Z (9 months ago)
- Topics: docs, endpoint, example, getting, js, kita, kitajs, minimal, rest, started, typescript
- Language: TypeScript
- Homepage: https://kita.js.org
- Size: 65.4 KB
- Stars: 7
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
KitaJS Minimal Example
## Setup
#### 🆕 Try it out in under a minute at [codespaces.new/kitajs/minimal-example](https://codespaces.new/kitajs/minimal-example).
#### 🔴 Test out a live deployment at [kitajs-minimal-example.up.railway.app](https://kitajs-minimal-example.up.railway.app/reference).
You can also clone this repository locally:
```sh
# clone the repo
git clone https://github.com/kitajs/minimal-example.git app
# Cd into it
cd app
# Install dependencies
npm install
# Build the app
npm run build
# Start the app
npm start
```
## Documentation
You can find the documentation at [kita.js.org](https://kita.js.org). This is a minimal example without any boilerplate or custom configuration, making it the best way to bootstrap your app without unnecessary setup.
## Getting Started
Firstly, let's review everything you need to know to get started with KitaJS.
1. Make sure your IDE is using the TypeScript project version. For VSCode, you can check that by opening the command palette and typing `TypeScript: Select TypeScript Version` and selecting `Use Workspace Version`. This will add useful debugging information to your IDE. You can test it by writing `export function post(a: 1) {}` into `src/routes/index.ts`, and you should see an error in your IDE.
2. You can start your server by running `npm run build` and `npm start`.
3. To add more routes, simply create a new file under `src/routes`. The file name will be the route path; for example, `src/routes/users.ts` will be `/users`. Afterward, export a function with one of the following names: `get`, `post`, `put`, `delete`, or `all`. By adding parameters to the newly created method, KitaJS automatically generates route validation, a Swagger schema, and types.
4. You must encapsulate your parameters with one of Kita's generic methods: `Body`, `BodyProp`, `Query`, `Path`, `Header`, and many others that you can find in the documentation. You can also use `FastifyInstance`, `FastifyRequest`, and `FastifyReply` to access the Fastify instance, request, and reply objects. You can hover over each type to see its documentation and usage examples.
## Boilerplate
1. In your tsconfig, we added `"plugins": [{ "name": "@kitajs/ts-plugin" }]` to enable your editor to help you with IntelliSense.
2. We only need `@kitajs/runtime` and `fastify` as production dependencies. You can see the only "configuration" file at [src/index.ts](src/index.ts). `@fastify/swagger` and `@fastify/swagger-ui` are only used to generate documentation at `http://localhost:1227/docs`.
3. The `build` script calls `kita build` before `tsc`, which is the correct order because we need to read type information from the source files.
4. You can run the `test` script to check if your code compiles correctly. `--dry-run` and `--noEmit` prevent KitaJS and TypeScript from emitting files, which is useful for testing.
5. You can run `npm run dev` to instantly reflect your changes into your server. This is useful for development.
6. Start your server by running `node dist/index.js` or `npm start`.
7. Done! 🎉
## Swagger
After starting your server, you can access [`http://localhost:1227/documentation`](http://localhost:1227/documentation).
