forked from
rocksky.app/rocksky
A decentralized music tracking and discovery platform built on AT Protocol 🎵
remove README files in sub-packages
-125
-25
apps/api/README.md
-25
apps/api/README.md
···
1
-
# Cloudflare Workers OpenAPI 3.1
2
-
3
-
This is a Cloudflare Worker with OpenAPI 3.1 using [chanfana](https://github.com/cloudflare/chanfana) and [Hono](https://github.com/honojs/hono).
4
-
5
-
This is an example project made to be used as a quick start into building OpenAPI compliant Workers that generates the
6
-
`openapi.json` schema automatically from code and validates the incoming request to the defined parameters or request body.
7
-
8
-
## Get started
9
-
10
-
1. Sign up for [Cloudflare Workers](https://workers.dev). The free tier is more than enough for most use cases.
11
-
2. Clone this project and install dependencies with `npm install`
12
-
3. Run `wrangler login` to login to your Cloudflare account in wrangler
13
-
4. Run `wrangler deploy` to publish the API to Cloudflare Workers
14
-
15
-
## Project structure
16
-
17
-
1. Your main router is defined in `src/index.ts`.
18
-
2. Each endpoint has its own file in `src/endpoints/`.
19
-
3. For more information read the [chanfana documentation](https://chanfana.pages.dev/) and [Hono documentation](https://hono.dev/docs).
20
-
21
-
## Development
22
-
23
-
1. Run `wrangler dev` to start a local instance of the API.
24
-
2. Open `http://localhost:8787/` in your browser to see the Swagger interface where you can try the endpoints.
25
-
3. Changes made in the `src/` folder will automatically trigger the server to reload, you only need to refresh the Swagger interface.
-50
apps/web-mobile/README.md
-50
apps/web-mobile/README.md
···
1
-
# React + TypeScript + Vite
2
-
3
-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
4
-
5
-
Currently, two official plugins are available:
6
-
7
-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8
-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9
-
10
-
## Expanding the ESLint configuration
11
-
12
-
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
13
-
14
-
- Configure the top-level `parserOptions` property like this:
15
-
16
-
```js
17
-
export default tseslint.config({
18
-
languageOptions: {
19
-
// other options...
20
-
parserOptions: {
21
-
project: ['./tsconfig.node.json', './tsconfig.app.json'],
22
-
tsconfigRootDir: import.meta.dirname,
23
-
},
24
-
},
25
-
})
26
-
```
27
-
28
-
- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
29
-
- Optionally add `...tseslint.configs.stylisticTypeChecked`
30
-
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
31
-
32
-
```js
33
-
// eslint.config.js
34
-
import react from 'eslint-plugin-react'
35
-
36
-
export default tseslint.config({
37
-
// Set the react version
38
-
settings: { react: { version: '18.3' } },
39
-
plugins: {
40
-
// Add the react plugin
41
-
react,
42
-
},
43
-
rules: {
44
-
// other rules...
45
-
// Enable its recommended rules
46
-
...react.configs.recommended.rules,
47
-
...react.configs['jsx-runtime'].rules,
48
-
},
49
-
})
50
-
```
-50
apps/web/README.md
-50
apps/web/README.md
···
1
-
# React + TypeScript + Vite
2
-
3
-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
4
-
5
-
Currently, two official plugins are available:
6
-
7
-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8
-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9
-
10
-
## Expanding the ESLint configuration
11
-
12
-
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
13
-
14
-
- Configure the top-level `parserOptions` property like this:
15
-
16
-
```js
17
-
export default tseslint.config({
18
-
languageOptions: {
19
-
// other options...
20
-
parserOptions: {
21
-
project: ['./tsconfig.node.json', './tsconfig.app.json'],
22
-
tsconfigRootDir: import.meta.dirname,
23
-
},
24
-
},
25
-
})
26
-
```
27
-
28
-
- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
29
-
- Optionally add `...tseslint.configs.stylisticTypeChecked`
30
-
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
31
-
32
-
```js
33
-
// eslint.config.js
34
-
import react from 'eslint-plugin-react'
35
-
36
-
export default tseslint.config({
37
-
// Set the react version
38
-
settings: { react: { version: '18.3' } },
39
-
plugins: {
40
-
// Add the react plugin
41
-
react,
42
-
},
43
-
rules: {
44
-
// other rules...
45
-
// Enable its recommended rules
46
-
...react.configs.recommended.rules,
47
-
...react.configs['jsx-runtime'].rules,
48
-
},
49
-
})
50
-
```