https://github.com/hammadmajid/fintraq-svelte
An app I made to play around with Hono, SvelteKit on Cloudfalre
https://github.com/hammadmajid/fintraq-svelte
cloudflare honojs sveltekit
Last synced: about 1 month ago
JSON representation
An app I made to play around with Hono, SvelteKit on Cloudfalre
- Host: GitHub
- URL: https://github.com/hammadmajid/fintraq-svelte
- Owner: hammadmajid
- License: unlicense
- Created: 2024-08-11T18:49:23.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-01T14:39:56.000Z (8 months ago)
- Last Synced: 2024-10-21T05:26:32.008Z (6 months ago)
- Topics: cloudflare, honojs, sveltekit
- Language: Svelte
- Homepage: https://fintraq.pages.dev
- Size: 673 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cloudflare Workers OpenAPI 3.1
This is a Cloudflare Worker with OpenAPI 3.1 using [chanfana](https://github.com/cloudflare/chanfana) and [Hono](https://github.com/honojs/hono).
This is an example project made to be used as a quick start into building OpenAPI compliant Workers that generates the
`openapi.json` schema automatically from code and validates the incoming request to the defined parameters or request body.
## Get started
1. Sign up for [Cloudflare Workers](https://workers.dev). The free tier is more than enough for most use cases.
2. Clone this project and install dependencies with `npm install`
3. Run `wrangler login` to login to your Cloudflare account in wrangler
4. Run `wrangler deploy` to publish the API to Cloudflare Workers
## Project structure
1. Your main router is defined in `src/index.ts`.
2. Each endpoint has its own file in `src/endpoints/`.
3. For more information read the [chanfana documentation](https://chanfana.pages.dev/) and [Hono documentation](https://hono.dev/docs).
## Development
1. Run `wrangler dev` to start a local instance of the API.
2. Open `http://localhost:8787/` in your browser to see the Swagger interface where you can try the endpoints.
3. Changes made in the `src/` folder will automatically trigger the server to reload, you only need to refresh the Swagger interface.