mirror of
https://github.com/linsa-io/linsa.git
synced 2026-01-12 12:20:23 +01:00
chore: project config and docs (#152)
* refactor(eslint): improve config readability and structure * chore(tsconfig): group options and add explanatory comments * docs(readme): restructure for clearer setup and contribution guide
This commit is contained in:
@@ -1,33 +1,49 @@
|
||||
# [Learn-Anything.xyz](https://learn-anything.xyz)
|
||||
# Learn-Anything.xyz
|
||||
|
||||
[](https://x.com/learnanything_)
|
||||
|
||||
[Learn-Anything.xyz](https://learn-anything.xyz) is an open-source learning platform.
|
||||
|
||||
Visit the website at: https://learn-anything.xyz
|
||||
|
||||
## Setup
|
||||
|
||||
Using [Bun](https://bun.sh).
|
||||
[Bun](https://bun.sh) is required to run this project.
|
||||
|
||||
```
|
||||
Install dependencies:
|
||||
|
||||
```bash
|
||||
bun i
|
||||
```
|
||||
|
||||
[Jazz](https://jazz.tools/) is used for all global/local state management.
|
||||
## Run Website
|
||||
|
||||
## Run website
|
||||
To start the website locally:
|
||||
|
||||
```
|
||||
```bash
|
||||
bun web
|
||||
```
|
||||
|
||||
## Contribute
|
||||
## Development
|
||||
|
||||
Currently things are unstable but will improve.
|
||||
- [Jazz](https://jazz.tools/) is used for all global/local state management.
|
||||
- The project is currently in an unstable state but actively improving.
|
||||
|
||||
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.
|
||||
## Contributing
|
||||
|
||||
Can always submit draft PRs with good ideas/fixes. We will help along the way to make it merge ready.
|
||||
We welcome contributions! Here's how you can get involved:
|
||||
|
||||
## Chat
|
||||
1. Join our [Discord](https://discord.gg/bxtD8x6aNF) and ask for help in the `#dev` channel.
|
||||
2. Submit draft PRs with your ideas or fixes. We'll guide you through the process.
|
||||
|
||||
Community chat in [Discord server](https://discord.gg/bxtD8x6aNF).
|
||||
## Community
|
||||
|
||||
Internal dev chat in Telegram (can email `join@learn-anything.xyz` to join core team). We will reach out with offer to join if you contribute to repo in form of PRs too.
|
||||
- **Public Chat**: Join our [Discord server](https://discord.gg/bxtD8x6aNF).
|
||||
- **Internal Dev Chat**: Available on Telegram.
|
||||
- Email `join@learn-anything.xyz` to join the core team.
|
||||
- Active contributors may receive invitations to join.
|
||||
|
||||
[](https://x.com/learnanything_)
|
||||
## Notes
|
||||
|
||||
- The project is in active development. Expect frequent changes.
|
||||
- We prioritize quick onboarding and unblocking of contributors.
|
||||
|
||||
Reference in New Issue
Block a user