Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
katniny committed Jan 7, 2025
1 parent 4d64430 commit fedfdd8
Showing 1 changed file with 25 additions and 19 deletions.
44 changes: 25 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,43 @@
<img src="https://transs.social/assets/imgs/All_transparent.png" />
<div align="center">
<img src="https://transs.social/assets/imgs/All_transparent.png" />

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/katniny/transsocial/firebase-hosting-merge.yml) <a href="/LICENSE"><img alt="Static Badge" src="https://img.shields.io/badge/license-CC BY–NC–SA 4.0-blue"></a>
</a>

🌎 <a href="https://transs.social/" target="_blank">TransSocial</a> is an open source social media platform built from the ground up with Firebase! πŸš€
</div>


---

## πŸš€ Features
- Privacy-Focused\
TransSocial is 100% privacy focused! TransSocial does not track you across the web, force an algorithm on you, just pure TransSocial.
- Experiments\
Try TransSocial features before they're fully released! Go to your Settings > Personalization then "Experiments"!
- Themes\
Try multiple themes! Such as the classic Dark and Light modes, but also Midnight Purple, Mint, and more! You can even create your own themes! 🎨
### and much more to come!
- Privacy-Focused
- TransSocial is 100% privacy focused! TransSocial does not track you across the web, force an algorithm on you, just pure TransSocial.
- Experiments
- Try TransSocial features before they're fully released! Go to your Settings > Personalization then "Experiments"!
- Themes
- Try multiple themes! Such as the classic Dark and Light modes, but also Midnight Purple, Mint, and more! You can even create your own themes! 🎨
### and much more available, and to come soon!

<br />

## How to Install/Use
## πŸ§‘β€πŸ’» How to Contribute
This needs to be rewritten as we've upgraded and changed our hosting provider to Firebase Hosting. Please bear with me.
But until I decide to do that, please note:
- To contribute to server-side code, you need a Firebase project with the Blaze Plan as Firebase Functions are unavailable otherwise. Otherwise, a Spark Plan project should suffice (but I haven't tested, please let me know if I'm wrong).
- You need the Firebase CLI installed and connected to a project. You can install it with `npm i -g firebase-tools` (please don't replace our firebase.json, we use it to host!)
- To test locally, run `firebase emulators:start`. The Firebase Functions will start as well testing hosting. This will ensure things run as you would see on our site. If you don't do this and attempt to visit a page (e.g. /u/katniny) and it doesn't work, don't complain about it to me. If you do that and it doesn't work, then I'll help.
- NOTE: When making changes to the client, you must MANUALLY refresh the page for your changes to take effect (if your changes don't take effect, refresh without cache (Ctrl + Shift + R))! When changing hosting settings or server-side code, you may sometimes need to Ctrl + C out and run `firebase emulators:start` again.
- `firebase serve` might work too, I have not tested it though.
But until I decide to do that (which will be soon), please note:
- Contributing to TransSocial (the website/app) requires the "Pay as you go" (aka Blaze plan) plan for Firebase. Unfortunately, this is due to changes to our own setup, as well as Firebase itself, such as storage now requiring the Blaze Plan because TransSocial relies on storage heavily for profile pictures, banners, etc.
- **NOTE**: Pay as you go requires a credit card and a Google Cloud Billing Account. You will not be charged under certain usage limits, which one individual should not reach by themselves. Learn more about Pay as you go usage limits at https://firebase.google.com/pricing
- The TransSocial Desktop/Mobile applications are currently not open source and are hardly maintained. Due to issues with how the old autoupdater worked on these applications, we need to rewrite it using Tauri's own autoupdater, which is more reliable. Once we do this, we will open source them <a href="/app">here</a>. We are unsure how we will build these apps, so we will not be providing available platforms as of yet.

<br />

## License

## πŸ“ƒ License
Copyright (c) 2025 katniny and contributors. All rights reserved.

TransSocial is licensed under CC BY-NC-SA 4.0: <https://creativecommons.org/licenses/by-nc-sa/4.0/>\
TransSocial's code is licensed under CC BY-NC-SA 4.0: <https://creativecommons.org/licenses/by-nc-sa/4.0/>\
The license is also available in the [LICENSE](/LICENSE) file in the root of this repository.

TransSocial is property of Katniny Studios.

A full list of contributors can be found at <https://transs.social/contributors>

The above copyright notice covers all contents of this repository barring the following exceptions:
Expand All @@ -42,4 +48,4 @@ The above copyright notice covers all contents of this repository barring the fo

Further copyright related information can be found at <https://transs.social/opensource>

## Thank you to everyone that's contributed to TransSocial!
## πŸ™Œ Thank you to everyone that's contributed to TransSocial!

0 comments on commit fedfdd8

Please sign in to comment.