Skip to content

Commit 11a3fb1

Browse files
authored
Linting and made model card more consistent. (#289)
* Linting and made model card more consistent. * Updated contributors guide.
1 parent 4a36ff8 commit 11a3fb1

26 files changed

+283
-438
lines changed

bun.lock

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"lockfileVersion": 1,
3+
"workspaces": {
4+
"": {
5+
"dependencies": {
6+
"@vercel/analytics": "^1.5.0",
7+
},
8+
},
9+
},
10+
"packages": {
11+
"@vercel/analytics": ["@vercel/[email protected]", "", { "peerDependencies": { "@remix-run/react": "^2", "@sveltejs/kit": "^1 || ^2", "next": ">= 13", "react": "^18 || ^19 || ^19.0.0-rc", "svelte": ">= 4", "vue": "^3", "vue-router": "^4" }, "optionalPeers": ["@remix-run/react", "@sveltejs/kit", "next", "react", "svelte", "vue", "vue-router"] }, "sha512-MYsBzfPki4gthY5HnYN7jgInhAZ7Ac1cYDoRWFomwGHWEX7odTEzbtg9kf/QSo7XEsEAqlQugA6gJ2WS2DEa3g=="],
12+
}
13+
}

www/DEPLOYMENT.md

Lines changed: 0 additions & 213 deletions
This file was deleted.

www/README.md

Lines changed: 95 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,39 +14,47 @@ This repository contains the source code for the Foundry Local website, built wi
1414

1515
## Technology Stack
1616

17+
- **Runtime**: Bun (recommended) or Node.js 18+
1718
- **Framework**: SvelteKit 2.x
1819
- **Styling**: TailwindCSS with custom components from shadcn-svelte
1920
- **Language**: TypeScript
2021
- **Build Tool**: Vite 6.x
21-
- **Deployment**: Vercel (via adapter-auto)
22+
- **Deployment**: Vercel (via adapter-vercel)
2223

2324
## Development
2425

2526
### Prerequisites
2627

27-
- Node.js 18+ or 20+
28-
- npm or pnpm
28+
- **Bun** (recommended) - [Install Bun](https://bun.sh)
29+
- **Node.js 18+** and npm (alternative)
2930

3031
### Setup
3132

3233
```bash
3334
# Install dependencies
34-
npm install
35+
bun install # Using Bun (recommended)
36+
# or
37+
npm install # Using npm
3538

3639
# Start development server
37-
npm run dev
40+
bun run dev # Using Bun
41+
# or
42+
npm run dev # Using npm
3843

3944
# Open http://localhost:5173
4045
```
4146

4247
### Available Scripts
4348

44-
- `npm run dev` - Start development server
45-
- `npm run build` - Build for production
46-
- `npm run preview` - Preview production build
47-
- `npm run check` - Run Svelte type checking
48-
- `npm run format` - Format code with Prettier
49-
- `npm run lint` - Check code formatting
49+
| Command | Description |
50+
|---------|-------------|
51+
| `bun run dev` / `npm run dev` | Start development server with hot reload |
52+
| `bun run build` / `npm run build` | Build for production |
53+
| `bun run preview` / `npm run preview` | Preview production build locally |
54+
| `bun run check` / `npm run check` | Run Svelte type checking |
55+
| `bun run check:watch` / `npm run check:watch` | Run type checking in watch mode |
56+
| `bun run format` / `npm run format` | Format code with Prettier |
57+
| `bun run lint` / `npm run lint` | Check code formatting |
5058

5159
## Project Structure
5260

@@ -74,14 +82,88 @@ www/
7482

7583
```bash
7684
# Create production build
77-
npm run build
85+
bun run build # Using Bun
86+
# or
87+
npm run build # Using npm
7888

7989
# Test the production build locally
80-
npm run preview
90+
bun run preview # Using Bun
91+
# or
92+
npm run preview # Using npm
8193
```
8294

8395
The built files will be in `.svelte-kit/output/`.
8496

97+
## Contributing
98+
99+
We welcome contributions to the Foundry Local website! Here's how to get started:
100+
101+
### Development Workflow
102+
103+
1. **Install dependencies**
104+
```bash
105+
bun install # Using Bun (recommended)
106+
# or
107+
npm install # Using npm
108+
```
109+
110+
2. **Make your changes**
111+
- Edit components in `src/lib/components/`
112+
- Update routes in `src/routes/`
113+
- Modify styles in `src/app.css` or component files
114+
115+
3. **Format your code**
116+
```bash
117+
bun run format # Auto-format with Prettier
118+
# or
119+
npm run format
120+
```
121+
122+
4. **Run type checking**
123+
```bash
124+
bun run check # Verify TypeScript types
125+
# or
126+
npm run check
127+
```
128+
129+
5. **Test locally**
130+
```bash
131+
bun run dev # Start dev server
132+
# or
133+
npm run dev
134+
```
135+
136+
6. **Build and preview**
137+
```bash
138+
bun run build && bun run preview
139+
# or
140+
npm run build && npm run preview
141+
```
142+
143+
### Code Quality
144+
145+
- **Formatting**: Code is formatted with Prettier using the following settings:
146+
- Tabs for indentation
147+
- Single quotes
148+
- No trailing commas
149+
- 100 character line width
150+
- Svelte-specific formatting via `prettier-plugin-svelte`
151+
152+
- **Type Safety**: All code must pass TypeScript type checking. Run `bun run check` before committing.
153+
154+
- **Linting**: Code formatting is enforced via `bun run lint`. Run `bun run format` to auto-fix issues.
155+
156+
### Best Practices
157+
158+
- Always run `bun run format` before committing to ensure consistent code style
159+
- Run `bun run check` to catch type errors early
160+
- Test your changes in both development and production builds for significant features
161+
- Preview production builds locally to verify optimizations work correctly
162+
163+
### Contributor License Agreement
164+
165+
This project requires contributors to sign a Contributor License Agreement (CLA). When you submit a pull request, a CLA bot will guide you through the process. For more details, see the [CONTRIBUTING.md](../CONTRIBUTING.md) file in the repository root.
166+
85167
## Deployment
86168

87169
This site is configured to deploy automatically to Vercel using `@sveltejs/adapter-auto`. Push to the main branch to trigger a deployment.

0 commit comments

Comments
 (0)