Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs #401

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Docs #401

wants to merge 7 commits into from

Conversation

BrightonMboya
Copy link
Contributor

Initial Draft for the t3 docs.
Kindly note: The home page is yet to be designed


#### Prerequisites

1. We do not recommend deploying a SQLite database on serverless environments since the data wouldn't be persisted. I provisioned a quick Postgresql database on [Railway](https://railway.app), but you can of course use any other database provider. Make sure the prisma schema is updated to use the correct database.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this sentence is kinda dumb now that tools like Turso exists. Should probably rephrase that it's the on-disk file-solution you shouldn't use in serverless 🤷🏼‍♂️

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I copy pasted it from the ReadMe though, I guess we will have to remove from there as well.
Will check the new state of the repo again and make the necessary changes

Comment on lines +15 to +19
### npm

```bash
npx create-turbo@latest -e https://github.com/t3-oss/create-t3-turbo
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this doesn't work.

this repo requires PNPM

Comment on lines +19 to +21
```bash
npm install -g @pnpm/exe
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

huh? never seen this before

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fwiw I recommend using corepack to keep your pacakge manager version synced


## Databases

Modify the `schema.prisma` file to use sqlite or any other provider of your choice
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might be good with a note here saying that sqlite is generally for development only, or that you should use a hosted solution like turso if you want to keep sqlite in prod

Comment on lines +80 to +81
### `.eslintrc.js`
The `.eslintrc.cjs` file is used to configure ESLint. See [ESLint Docs↗](https://eslint.org/docs/latest/use/configure/configuration-files) for more information.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i removed this today as i did some restructuring of things.

might be good to look over this entire page to make sure it's valid

Comment on lines +19 to +28
### `apps/expo/package.json`

In here, you need to delete the entry point or replace it with `index.tsx`.

```javascript
{
"main": "index.tsx",
...
}
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'd prefer it if we use nextra but not a hard pass with docusaurus either.

also heard super good stuff about mintlify but never tried it and to be honest not 100% sure what it is xdd https://mintlify.com/docs/quickstart

@juliusmarminge
Copy link
Member

Sorry for taking so long to get back to you on this. Just been super busy with other stuff that I haven't had time to look over this repo in a while...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants