starred/linsa-linsa-io
1
0
Fork 0
mirror of https://github.com/linsa-io/linsa.git synced 2026-01-11 22:40:32 +01:00
Code Issues 2 Packages Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Nikita
2024-12-05 17:19:48 +01:00
parent a9794e07c0
commit b8b984ac95
2 changed files with 48 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
readme.md
View File

@@ -2,55 +2,9 @@
> Organize world's knowledge, explore connections and curate learning paths
### Files
## Web
- [web](web) - website hosted on [learn-anything.xyz](https://learn-anything.xyz) (using [React](https://react.dev/), [TanStack Start](https://tanstack.com/start/latest), [Jazz](https://jazz.tools/))
## Setup
> [!NOTE]
> Project is currently in unstable state for contributions but actively improving. Reach out on [Discord](https://discord.gg/bxtD8x6aNF) for help.
Using [Bun](https://bun.sh):
```
bun i
```
> [!NOTE]
> bun setup is not yet done but will be a command to fully bootstrap a local working env for the project
```
bun setup
```
You need to have this `web/.env` in order to run the website:
```
### ALL
RONIN_TOKEN=
### DEV
VITE_APP_NAME="Learn Anything"
VITE_APP_URL=http://localhost:3000
VITE_CLERK_PUBLISHABLE_KEY=
VITE_CLERK_SIGN_IN_URL=/sign-in
VITE_CLERK_SIGN_UP_URL=/sign-up
VITE_JAZZ_PEER_URL=
VITE_JAZZ_GLOBAL_GROUP_ID=
CLERK_SECRET_KEY=
```
Currently the way to get them is to message us on [Discord](https://discord.gg/bxtD8x6aNF) (this will be improved/automated).
## Run website
```
bun web
```
See [web](web) to run website.
## Contributing
@@ -60,7 +14,7 @@ Can [open new issue](../../issues/new/choose) (search [existing ones](../../issu
Can submit draft PRs with good ideas/fixes. You will get help along the way to make it merge ready.
Ask for help on [Discord](https://discord.gg/bxtD8x6aNF)'s [#dev channel](https://discord.com/channels/428579844046192640/1171861795867209798). You will be unblocked fast.
Ask for help on [Discord](https://discord.gg/bxtD8x6aNF)'s [#dev channel](https://discord.com/channels/428579844046192640/1171861795867209798). You will be unblocked fast. Often voice channels are used for pairing / working in public.
## Join core team

45
web/readme.md Normal file
View File

@@ -0,0 +1,45 @@
> [!WARNING]
> Setup is not tuned for OSS contributions, specifically getting the `.env` is tricky, it will be improved
> [!NOTE]
> Reach out on [Discord](https://discord.gg/bxtD8x6aNF) for help if things fail in setup/dev
## Setup
Need this `.env`:
```
### ALL
RONIN_TOKEN=
### DEV
VITE_APP_NAME="Learn Anything"
VITE_APP_URL=http://localhost:3000
VITE_CLERK_PUBLISHABLE_KEY=
VITE_CLERK_SIGN_IN_URL=/sign-in
VITE_CLERK_SIGN_UP_URL=/sign-up
VITE_JAZZ_PEER_URL=
VITE_JAZZ_GLOBAL_GROUP_ID=
CLERK_SECRET_KEY=
```
`CLERK_` come from [Clerk](https://clerk.com) workspace. `VITE_JAZZ_` comes from [Jazz](https://jazz.tools/).
```
bun i
```
## Run
```
bun dev
```
## Stack
- [TanStack Start](https://tanstack.com/start/latest) - react framework (routing, server actions, ..)
- [Jazz](https://jazz.tools) - local/server state (sync engine)
- [Clerk](https://clerk.com) - auth