Files
archived-linsa/readme.md
Aslam 57289326db 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
2024-09-08 06:29:55 +07:00

50 lines
1.2 KiB
Markdown

# Learn-Anything.xyz
[![X](https://img.shields.io/badge/learnanything-100000?logo=X&color=black)](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
[Bun](https://bun.sh) is required to run this project.
Install dependencies:
```bash
bun i
```
## Run Website
To start the website locally:
```bash
bun web
```
## Development
- [Jazz](https://jazz.tools/) is used for all global/local state management.
- The project is currently in an unstable state but actively improving.
## Contributing
We welcome contributions! Here's how you can get involved:
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
- **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.
## Notes
- The project is in active development. Expect frequent changes.
- We prioritize quick onboarding and unblocking of contributors.