36 lines
1.1 KiB
Markdown
36 lines
1.1 KiB
Markdown
# userbase starter: React Router
|
|
A minimal React Router project with userbase integration.
|
|
|
|
## Project Structure
|
|
|
|
Inside of your React Router project, you'll see the following folders and files:
|
|
|
|
```text
|
|
/
|
|
├── public/
|
|
├── app/
|
|
│ ├── userbase.ts
|
|
│ ├── root.tsx
|
|
│ └── routes/
|
|
│ ├── _index.tsx
|
|
│ ├── admin.$.tsx
|
|
│ └── api.$.tsx
|
|
└── package.json
|
|
```
|
|
|
|
To update `userbase` config, check `app/routes/api.$.ts` and `app/routes/admin.$.ts`.
|
|
|
|
## Commands
|
|
|
|
All commands are run from the root of the project, from a terminal:
|
|
|
|
| Command | Action |
|
|
|:--------------------------|:--------------------------------------------|
|
|
| `npm install` | Installs dependencies |
|
|
| `npm run dev` | Starts local dev server at `localhost:5173` |
|
|
| `npm run build` | Build your production site |
|
|
|
|
## Want to learn more?
|
|
|
|
Feel free to check [our documentation](https://docs.userbase.io/integration/remix) or jump into our [Discord server](https://discord.gg/952SFk8Tb8).
|