Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lightable/lightable
[Alpha] - Open-source Chat client, reimagined
https://github.com/lightable/lightable
chat creative-commons free fun inspiration oss self-hosting svelte tauri vite vue wails
Last synced: 2 days ago
JSON representation
[Alpha] - Open-source Chat client, reimagined
- Host: GitHub
- URL: https://github.com/lightable/lightable
- Owner: Lightable
- License: other
- Created: 2022-04-19T01:22:19.000Z (over 2 years ago)
- Default Branch: pre-alpha
- Last Pushed: 2022-10-22T15:28:35.000Z (about 2 years ago)
- Last Synced: 2024-06-20T06:22:15.550Z (5 months ago)
- Topics: chat, creative-commons, free, fun, inspiration, oss, self-hosting, svelte, tauri, vite, vue, wails
- Language: Vue
- Homepage: https://lightable.app
- Size: 59.3 MB
- Stars: 16
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Lightable
This is a monorepo of all things lightable
#### Table of contents
* [Naming Scheme](https://github.com/brys0/Lightable#naming-scheme)
* [Who](https://github.com/brys0/Lightable#who-is-lightable#Who-is-lightable)
* [What](https://github.com/brys0/Lightable#What-is-lightable)
* [When](https://github.com/brys0/Lightable#When-is-lightable)
* [Where](https://github.com/brys0/Lightable#Where-is-lightable)
* [Why](https://github.com/brys0/Lightable#Why-is-lightable)
* [FAQ](https://github.com/brys0/Lightable#faq)
* [Getting an invite](https://github.com/Lightable#Getting-an-invite)
* [Becoming an administrator](https://github.com/brys0/Lightable#becoming-an-administrator)
- [Guidelines](https://github.com/brys0/Lightable#guidelines)
* [Just because](https://github.com/brys0/Lightable#just-because)
* [Preview](https://github.com/brys0/Lightable#preview)
* [💖Inspirations💖](https://github.com/brys0/Lightable#Inspirations)
### [Wiki](https://github.com/brys0/Lightable/wiki)
## Naming Scheme
* Arc `CDN` /packages/arc (Coming Soon)
* Lava `Real Time Voice/Media` /packages/lava (Documentation Soon)
* Server `API Service` /packages/server
* Web `Web client` /packages/web
* Desktop `Desktop client` /packages/desktop-wails /packages/desktop
## Who is lightable?
At this moment, Lightable is entirely written by one person.
## What is lightable?
Open source chat client for your mates to have a bit of a faff
### Client `/packages/desktop` `/packages/desktop-wails` `/packages/web`
UI Framework: VueJS
UI Library: naive-ui
Desktop Library: Wails/Tauri
### API Server `/packages/server`
Language: Kotlin
API Framework: Javalin
#### Microservices
* Coming soon
## When is lightable?
For now, I feel lightable as still quite pre-release software.
## Where is lightable?
Lightable is self-hosted, with the intention of having multiple hosts across multiple different people, and groups. It's made to be hosted by anyone!
## Why is lightable?
Being inspired by many Chat apps that have been created I wanted to take my own journey learning programming in the process
FAQ
> I want to run my own servers, how do I do that?
[Guide](https://github.com/brys0/Lightable/wiki/Selfhost)
> I have an issue or bug with my use of this software
Lightable has many bugs right now, It's hard to track and fix all of them being a solo dev.
You can file an issue in the issues, or if you feel comfortable, you can try and make a pull request.
> How do I develop lightable?
[Guide](https://github.com/brys0/Lightable/wiki/Development)
## Getting an invite
Hey! Glad you're interested in trying out lightable while it's in its closed alpha stage
Here are some steps to receive an invite code:
* Sign up (for an invite) on the lightable desktop app
* Wait (If I don't respond in a week or-so I deeply apologize)
* Receive a code through the email address you used. (You'll receive it directly from me!)
* Sign up again, set your name, email, password.
* You'll see a modal asking for an invite code. Input your code, and have some fun!
## Becoming an administrator
Think you're cool enough to be an admin? Awesome!
Here are the steps to be **that** cool
1. Email me
- With your revelant information. Way to contact, name, etc.
- Why you want to be an admin
- How you would be a good fit
- How you can help this project grow
- Something about yourself, have some fun with it!
2. Wait
3. Don't be disappointed if I reject the request. No hard feelings. I will provide a reason, and the time until you can re-apply
4. If you get accepted, grats! Happy for you :)
### Guidelines
* Don't be stupid (Revoking people's, invite codes without a reason is VERY stupid)
* Don't be malcious (Don't troll, take it seriously)
* Don't leak peoples info. (Thats really scummy)
* Don't leak your own info
* Don't use your "role" for solicitating something (if anything like this EVER happens, consider yourself removed from this platform for life)
* Be smart, if you have a question. ASK. before taking action (If someone is doing something dumb, use your best judgement. If it's another Admin, shoot me a message, and I'll be sure to take action when I can)
* Help others out. Administration is not limited to controlling, if someone has a question respectfully, and diligently respond
## Just because...
Just because lightable is completely open-source, doesn't mean (project server) is free from moderation. If you feel the absolute undying want to ruin others day. Do it alone on your own self-hosted server.
## Preview
## Inspirations
Hyalus
Spacedrive
Discord
Revolt
This dribble post
💖 And many others 💖
1.12.5-ALPHA