mirror of
https://github.com/linsa-io/linsa.git
synced 2026-01-11 20:00:23 +01:00
fix: conflict
This commit is contained in:
53
readme.md
53
readme.md
@@ -4,19 +4,24 @@
|
||||
|
||||
## Files
|
||||
|
||||
- [api](api) - http services (using TS/[Encore](https://encore.dev/))
|
||||
- [app](app) - desktop app (wrapping the [website](web) with desktop specific logic) (using [Tauri](https://v2.tauri.app/))
|
||||
- [cli](cli) - cli (using [Go](https://go.dev))
|
||||
- [docs](https://github.com/learn-anything/docs) - public docs hosted on [docs.learn-anything.xyz](https://docs.learn-anything.xyz/)
|
||||
- [lib](lib) - shared utility functions in TS
|
||||
- [nix](nix) - shared nix code
|
||||
- [scripts](scripts) - utility scripts in TS
|
||||
- [web](web) - website hosted on [learn-anything.xyz](https://learn-anything.xyz) (using [React](https://react.dev/)/[Next.js](https://nextjs.org/) + [Jazz](https://jazz.tools/) for local/global state)
|
||||
- [lib](lib) - shared functions
|
||||
- [scripts](scripts) - utility scripts
|
||||
- [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/))
|
||||
|
||||
> [!NOTE]
|
||||
> Other folders present in repo are in non stable state.
|
||||
|
||||
<!-- TODO: make the folders stable/runnable and add them to `Files` -->
|
||||
<!-- - [api](api) - http services (using TS/[Encore](https://encore.dev/)) -->
|
||||
<!-- - [app](app) - desktop app (wrapping the [website](web) with desktop specific logic) (using [Tauri](https://v2.tauri.app/)) -->
|
||||
<!-- - [cli](cli) - cli (using [Go](https://go.dev)) -->
|
||||
<!-- - [docs](https://github.com/learn-anything/docs) - public docs hosted on [docs.learn-anything.xyz](https://docs.learn-anything.xyz/) -->
|
||||
<!-- - [nix](nix) - shared nix code -->
|
||||
|
||||
## Setup
|
||||
|
||||
> [!NOTE]
|
||||
> Project is currently in unstable state but actively improving. Reach out on [Discord](https://discord.gg/bxtD8x6aNF) for help.
|
||||
> 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):
|
||||
|
||||
@@ -25,12 +30,34 @@ bun i
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> bun setup is not yet done but will be a command to fully bootstrap a local working env for the project, without it, running `bun web` is impossible yet
|
||||
> 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
|
||||
|
||||
```
|
||||
@@ -39,9 +66,9 @@ bun web
|
||||
|
||||
## Contributing
|
||||
|
||||
If you want to help contribute to code, ask for help on [Discord](https://discord.gg/bxtD8x6aNF)'s `#dev` channel. You will be onboarded and unblocked fast.
|
||||
If you want to help contribute to code, ask for help on [Discord](https://discord.gg/bxtD8x6aNF)'s [#dev channel](https://discord.com/channels/428579844046192640/1171861795867209798). You will be onboarded and unblocked fast.
|
||||
|
||||
Can see [existing issues](../../issues) for things being worked on. See [main issue](../../issues/110) for what's in focus right now.
|
||||
Can see [existing issues](../../issues) for things being worked on.
|
||||
|
||||
Can [open new issue](../../issues/new/choose) (search existing ones for duplicates first) or start discussion on [GitHub](../../discussions) or [Discord](https://discord.gg/bxtD8x6aNF).
|
||||
|
||||
@@ -49,6 +76,6 @@ Can always submit draft PRs with good ideas/fixes. We will help along the way to
|
||||
|
||||
## Join core team
|
||||
|
||||
We are a small team of core developers right now but are always looking to expand. We will reach out with offer to join us if you contribute to repo in form of PRs.
|
||||
We are a small team of core developers right now but are always looking to expand. We will reach out with offer to join us if you contribute to repo in form of PRs. Can also contact us via [email](mailto:join@learn-anything.xyz).
|
||||
|
||||
[](https://discord.com/invite/bxtD8x6aNF) [](https://x.com/learnanything_)
|
||||
|
||||
@@ -130,7 +130,7 @@ const DropdownMenuItems: React.FC<DropdownMenuItemsProps> = ({
|
||||
<MenuLink href="/profile" icon="CircleUser" text="My profile" />
|
||||
<DropdownMenuItem className="gap-2" onClick={() => setShowShortcut(true)}>
|
||||
<LaIcon name="Keyboard" />
|
||||
<span>Shortcut</span>
|
||||
<span>Shortcuts</span>
|
||||
</DropdownMenuItem>
|
||||
<MenuLink href="/onboarding" icon="LayoutList" text="Onboarding" />
|
||||
<DropdownMenuSeparator />
|
||||
|
||||
Reference in New Issue
Block a user