-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from jcjoshuac/islina
added vite react convex boilerplate
- Loading branch information
Showing
23 changed files
with
4,473 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
module.exports = { | ||
root: true, | ||
env: { browser: true, es2020: true }, | ||
extends: [ | ||
'eslint:recommended', | ||
'plugin:@typescript-eslint/recommended', | ||
'plugin:react-hooks/recommended', | ||
], | ||
ignorePatterns: ['dist', '.eslintrc.cjs'], | ||
parser: '@typescript-eslint/parser', | ||
plugins: ['react-refresh'], | ||
rules: { | ||
'react-refresh/only-export-components': [ | ||
'warn', | ||
{ allowConstantExport: true }, | ||
], | ||
}, | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
pnpm-debug.log* | ||
lerna-debug.log* | ||
|
||
node_modules | ||
dist | ||
dist-ssr | ||
*.local | ||
|
||
# Editor directories and files | ||
.vscode/* | ||
!.vscode/extensions.json | ||
.idea | ||
.DS_Store | ||
*.suo | ||
*.ntvs* | ||
*.njsproj | ||
*.sln | ||
*.sw? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# React + TypeScript + Vite | ||
|
||
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. | ||
|
||
Currently, two official plugins are available: | ||
|
||
- [@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 | ||
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh | ||
|
||
## Expanding the ESLint configuration | ||
|
||
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: | ||
|
||
- Configure the top-level `parserOptions` property like this: | ||
|
||
```js | ||
export default { | ||
// other rules... | ||
parserOptions: { | ||
ecmaVersion: 'latest', | ||
sourceType: 'module', | ||
project: ['./tsconfig.json', './tsconfig.node.json'], | ||
tsconfigRootDir: __dirname, | ||
}, | ||
} | ||
``` | ||
|
||
- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked` | ||
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked` | ||
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
# Welcome to your Convex functions directory! | ||
|
||
Write your Convex functions here. See | ||
https://docs.convex.dev/using/writing-convex-functions for more. | ||
|
||
A query function that takes two arguments looks like: | ||
|
||
```ts | ||
// functions.js | ||
import { query } from "./_generated/server"; | ||
import { v } from "convex/values"; | ||
|
||
export const myQueryFunction = query({ | ||
// Validators for arguments. | ||
args: { | ||
first: v.number(), | ||
second: v.string(), | ||
}, | ||
|
||
// Function implementation. | ||
handler: async (ctx, args) => { | ||
// Read the database as many times as you need here. | ||
// See https://docs.convex.dev/database/reading-data. | ||
const documents = await ctx.db.query("tablename").collect(); | ||
|
||
// Arguments passed from the client are properties of the args object. | ||
console.log(args.first, args.second); | ||
|
||
// Write arbitrary JavaScript here: filter, aggregate, build derived data, | ||
// remove non-public properties, or create new objects. | ||
return documents; | ||
}, | ||
}); | ||
``` | ||
|
||
Using this query function in a React component looks like: | ||
|
||
```ts | ||
const data = useQuery(api.functions.myQueryFunction, { | ||
first: 10, | ||
second: "hello", | ||
}); | ||
``` | ||
|
||
A mutation function looks like: | ||
|
||
```ts | ||
// functions.js | ||
import { mutation } from "./_generated/server"; | ||
import { v } from "convex/values"; | ||
|
||
export const myMutationFunction = mutation({ | ||
// Validators for arguments. | ||
args: { | ||
first: v.string(), | ||
second: v.string(), | ||
}, | ||
|
||
// Function implementation. | ||
handler: async (ctx, args) => { | ||
// Insert or modify documents in the database here. | ||
// Mutations can also read from the database like queries. | ||
// See https://docs.convex.dev/database/writing-data. | ||
const message = { body: args.first, author: args.second }; | ||
const id = await ctx.db.insert("messages", message); | ||
|
||
// Optionally, return a value from your mutation. | ||
return await ctx.db.get(id); | ||
}, | ||
}); | ||
``` | ||
|
||
Using this mutation function in a React component looks like: | ||
|
||
```ts | ||
const mutation = useMutation(api.functions.myMutationFunction); | ||
function handleButtonPress() { | ||
// fire and forget, the most common way to use mutations | ||
mutation({ first: "Hello!", second: "me" }); | ||
// OR | ||
// use the result once the mutation has completed | ||
mutation({ first: "Hello!", second: "me" }).then((result) => | ||
console.log(result) | ||
); | ||
} | ||
``` | ||
|
||
Use the Convex CLI to push your functions to a deployment. See everything | ||
the Convex CLI can do by running `npx convex -h` in your project root | ||
directory. To learn more, launch the docs with `npx convex docs`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
/* eslint-disable */ | ||
/** | ||
* Generated `api` utility. | ||
* | ||
* THIS CODE IS AUTOMATICALLY GENERATED. | ||
* | ||
* Generated by [email protected]. | ||
* To regenerate, run `npx convex dev`. | ||
* @module | ||
*/ | ||
|
||
import type { | ||
ApiFromModules, | ||
FilterApi, | ||
FunctionReference, | ||
} from "convex/server"; | ||
|
||
/** | ||
* A utility for referencing Convex functions in your app's API. | ||
* | ||
* Usage: | ||
* ```js | ||
* const myFunctionReference = api.myModule.myFunction; | ||
* ``` | ||
*/ | ||
declare const fullApi: ApiFromModules<{}>; | ||
export declare const api: FilterApi< | ||
typeof fullApi, | ||
FunctionReference<any, "public"> | ||
>; | ||
export declare const internal: FilterApi< | ||
typeof fullApi, | ||
FunctionReference<any, "internal"> | ||
>; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
/* eslint-disable */ | ||
/** | ||
* Generated `api` utility. | ||
* | ||
* THIS CODE IS AUTOMATICALLY GENERATED. | ||
* | ||
* Generated by [email protected]. | ||
* To regenerate, run `npx convex dev`. | ||
* @module | ||
*/ | ||
|
||
import { anyApi } from "convex/server"; | ||
|
||
/** | ||
* A utility for referencing Convex functions in your app's API. | ||
* | ||
* Usage: | ||
* ```js | ||
* const myFunctionReference = api.myModule.myFunction; | ||
* ``` | ||
*/ | ||
export const api = anyApi; | ||
export const internal = anyApi; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
/* eslint-disable */ | ||
/** | ||
* Generated data model types. | ||
* | ||
* THIS CODE IS AUTOMATICALLY GENERATED. | ||
* | ||
* Generated by [email protected]. | ||
* To regenerate, run `npx convex dev`. | ||
* @module | ||
*/ | ||
|
||
import { AnyDataModel } from "convex/server"; | ||
import type { GenericId } from "convex/values"; | ||
|
||
/** | ||
* No `schema.ts` file found! | ||
* | ||
* This generated code has permissive types like `Doc = any` because | ||
* Convex doesn't know your schema. If you'd like more type safety, see | ||
* https://docs.convex.dev/using/schemas for instructions on how to add a | ||
* schema file. | ||
* | ||
* After you change a schema, rerun codegen with `npx convex dev`. | ||
*/ | ||
|
||
/** | ||
* The names of all of your Convex tables. | ||
*/ | ||
export type TableNames = string; | ||
|
||
/** | ||
* The type of a document stored in Convex. | ||
*/ | ||
export type Doc = any; | ||
|
||
/** | ||
* An identifier for a document in Convex. | ||
* | ||
* Convex documents are uniquely identified by their `Id`, which is accessible | ||
* on the `_id` field. To learn more, see [Document IDs](https://docs.convex.dev/using/document-ids). | ||
* | ||
* Documents can be loaded using `db.get(id)` in query and mutation functions. | ||
* | ||
* IDs are just strings at runtime, but this type can be used to distinguish them from other | ||
* strings when type checking. | ||
*/ | ||
export type Id<TableName extends TableNames = TableNames> = | ||
GenericId<TableName>; | ||
|
||
/** | ||
* A type describing your Convex data model. | ||
* | ||
* This type includes information about what tables you have, the type of | ||
* documents stored in those tables, and the indexes defined on them. | ||
* | ||
* This type is used to parameterize methods like `queryGeneric` and | ||
* `mutationGeneric` to make them type-safe. | ||
*/ | ||
export type DataModel = AnyDataModel; |
Oops, something went wrong.