66 lines
1.6 KiB
Markdown
66 lines
1.6 KiB
Markdown
# sgse-app
|
|
|
|
This project was created with [Better-T-Stack](https://github.com/AmanVarshney01/create-better-t-stack), a modern TypeScript stack that combines SvelteKit, Convex, and more.
|
|
|
|
## Features
|
|
|
|
- **TypeScript** - For type safety and improved developer experience
|
|
- **SvelteKit** - Web framework for building Svelte apps
|
|
- **TailwindCSS** - Utility-first CSS for rapid UI development
|
|
- **shadcn/ui** - Reusable UI components
|
|
- **Convex** - Reactive backend-as-a-service platform
|
|
- **Biome** - Linting and formatting
|
|
- **Turborepo** - Optimized monorepo build system
|
|
|
|
## Getting Started
|
|
|
|
First, install the dependencies:
|
|
|
|
```bash
|
|
bun install
|
|
```
|
|
|
|
## Convex Setup
|
|
|
|
This project uses Convex as a backend. You'll need to set up Convex before running the app:
|
|
|
|
```bash
|
|
bun dev:setup
|
|
```
|
|
|
|
Follow the prompts to create a new Convex project and connect it to your application.
|
|
|
|
Then, run the development server:
|
|
|
|
```bash
|
|
bun dev
|
|
```
|
|
|
|
Open [http://localhost:5173](http://localhost:5173) in your browser to see the web application.
|
|
Your app will connect to the Convex cloud backend automatically.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
sgse-app/
|
|
├── apps/
|
|
│ ├── web/ # Frontend application (SvelteKit)
|
|
├── packages/
|
|
│ ├── backend/ # Convex backend functions and schema
|
|
```
|
|
|
|
## Available Scripts
|
|
|
|
- `bun dev`: Start all applications in development mode
|
|
- `bun build`: Build all applications
|
|
- `bun dev:web`: Start only the web application
|
|
- `bun dev:setup`: Setup and configure your Convex project
|
|
- `bun check-types`: Check TypeScript types across all apps
|
|
- `bun check`: Run Biome formatting and linting
|