scriptoriumadmin/supermemory
1
0
Fork 0
mirror of https://github.com/supermemoryai/supermemory.git synced 2026-08-28 05:25:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

easier for contrbutors

Browse source
This commit is contained in:
Dhravya Shah 2026-05-06 22:46:44 -07:00
parent 8ad7055fe2
commit bb05ae5e2c
3 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING.md
View file

@ -48,10 +48,12 @@ Before you begin, ensure you have the following installed:
5. **Start the Development Server** 5. **Start the Development Server**
```bash ```bash
bun run dev bun run dev:local
``` ```
This will start all applications in the monorepo. The web app will be available at `http://localhost:3000`. This starts each app on plain `localhost` ports (web on 3000, mcp on 8788, docs on 3003, graph on 3004) and points the web app at the public API at `https://api.supermemory.ai` via `NEXT_PUBLIC_BACKEND_URL` in `.env.example`. Sign in with magic-link/email-OTP — Google/GitHub OAuth sign-in won't round-trip back to localhost.
> **Internal team note:** `bun run dev` (without `:local`) routes through [portless](https://github.com/portless/portless) to give every app a stable `*.dev.supermemory.ai` HTTPS URL with shared cookies and a working OAuth proxy. That path requires `bun run setup:dev` once (binds port 443, trusts a local CA). OSS contributors don't need it.
## 📁 Project Structure ## 📁 Project Structure
@ -84,7 +86,8 @@ supermemory/
### Available Scripts ### Available Scripts
- `bun run dev` - Start development servers for all apps - `bun run dev:local` - Start dev servers on plain localhost ports (recommended for OSS contributors)
- `bun run dev` - Start dev servers through portless (`*.dev.supermemory.ai`, internal team)
- `bun run build` - Build all applications - `bun run build` - Build all applications
- `bun run format-lint` - Format and lint code using Biome - `bun run format-lint` - Format and lint code using Biome
- `bun run check-types` - Type check all packages - `bun run check-types` - Type check all packages

1
package.json
View file

@ -4,6 +4,7 @@
"scripts": { "scripts": {
"build": "turbo run build", "build": "turbo run build",
"dev": "turbo run dev", "dev": "turbo run dev",
"dev:local": "turbo run dev:app",
"format-lint": "bunx biome check --write", "format-lint": "bunx biome check --write",
"check-types": "turbo run check-types", "check-types": "turbo run check-types",
"sentry:sourcemaps": "_SENTRY_RELEASE=$(sentry-cli releases propose-version) && sentry-cli releases new $_SENTRY_RELEASE --org=supermemory --project=consumer-app && sentry-cli sourcemaps upload --org=supermemory --project=consumer-app --release=$_SENTRY_RELEASE --strip-prefix 'dist/..' dist", "sentry:sourcemaps": "_SENTRY_RELEASE=$(sentry-cli releases propose-version) && sentry-cli releases new $_SENTRY_RELEASE --org=supermemory --project=consumer-app && sentry-cli sourcemaps upload --org=supermemory --project=consumer-app --release=$_SENTRY_RELEASE --strip-prefix 'dist/..' dist",

4
turbo.json
View file

@ -16,6 +16,10 @@
"dev": { "dev": {
"cache": false, "cache": false,
"persistent": true "persistent": true
},
"dev:app": {
"cache": false,
"persistent": true
} }
} }
} }