userbase/examples/solid/README.md

userbase starter: Solid Start

A minimal example of a Solid Start project with userbase integration.

Project Structure

Inside of your Solid Start project, you'll see the following folders and files:

.
├── userbase.config.ts
├── bun.lock
├── package.json
├── public
│   ├── admin # generated by userbase and contains the admin UI
│   ├── userbase.ico
│   ├── userbase.svg
│   ├── file.svg
│   ├── globe.svg
│   ├── solid.svg
│   └── window.svg
├── README.md # you're here
├── src
│   ├── app.css
│   ├── app.tsx
│   ├── components
│   │   ├── Footer.tsx
│   │   └── List.tsx
│   ├── entry-client.tsx
│   ├── entry-server.tsx
│   ├── global.d.ts
│   ├── lib
│   │   └── userbase.ts # initializes userbase instance
│   ├── middleware
│   │   └── index.ts # mounts userbase middleware
│   └── routes
│       ├── [...404].tsx
│       ├── index.tsx
│       └── user.tsx
├── tsconfig.json
└── vite.config.ts

Here is a quick overview about how to adjust the behavior of userbase:

• Initialization of the userbase config with helper functions are located at src/lib/userbase.ts
• Admin UI is rendered using src/middleware/index.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:3000
npm run build	Build your production site

Want to learn more?

Feel free to check our documentation or jump into our Discord server.