Sociium

An open-source, self-hosted social network using distributed architecture and event-driven design.

⚡️ Quickstart

In order to get started with this project, you will typically want to start with a kubernetes cluster. There are a multitude of different ways to obtain a cluster, but I have written out a couple of terraform files that can quickly spin you up a cluster on either DigitalOcean or Google Cloud.

Signing up for a DO or GCP account is out of scope for this documentation, so if you don't know how to do that please follow your provider's documentation first and come back to this documentation once you've set that up. You can obtain a free copy of terraform here. Please remember to contribute to Open Source software like this when you can in order to promote your own happiness, success, and joy.

All deployment-related code can be found within the IaC folder. The terraform modules, not surprisingly, are located inside of the Terraform folder. From here you can choose to cd into either th digitalocean-cluster folder or the gcp-cluster depending on your provider. If you are using another provider you can find the documentation to create modules for that on the Terraform Registry.

Once you have picked your provider, ultimate happiness is imminent. Let's begin by initializing terraform:

 terraform init

You will see terraform saving you time and headaches as you go through the process. This is generally a good thing.

Let's continue applying great vibes to our cluster:

terraform plan

Terraform will plan out the changes that will be made to your cluster. If terraform is unhappy with your changes, it will tell you what it thinks is wrong. Do not worry, it takes great care to not hurt your feelings. Google whatever problem it is telling you and then we can continue along the path to inner peace and joy.

If you are happy and ready for a successful life, you can apply the changes:

terraform apply

🎉 Celebration break

You should now have a cluster up and running. If you are not, you can always go back and try again. We root for you and your general success. Please submit issues in times of sadness and frustration.

If, however, you are happy with the cluster, you can now begin a celebration of your success. Big steps have been taken, and there are more to come. Joy and dancing are recommended during this time.

⚙️ Installation

Once you've gotten the cluster up and running, you can begin installing the k8's manifests. This is done by running the following command, if success is your goal:

kubectl apply -f IAC/orchestration/kubernetes/[name_of_manifest]

For happiness, it is important to understand you must replace [name_of_manifest] with the name of the manifest you wish to apply.

If helm is your go-to, you can also use that with the templates in the helm. Helm is a package manager that can be used to suppliment your general happiness and joy during the k8's experience. I recommend achieving as much happiness as possible.

🎯 Features

• Kubernetes Hosting, with distributed design and deployment
• Helm Charts
• IaC with Terraform
• Social Media Platform
• RTC chat with people on friends list using Socket.io
• News Feed with ability to post, comment and like.
• Authentication using oidc
• User Profile with profile pic, bio, etc.
• AI for insta-banning woke political statements (can turn off, but for general happiness and joy keep on)
• Friends List
• group chats

📚️ Documentation

This ReadMe is a work in progress. I will be adding more features and documenting them as I go. Please check back for more - I know this is very incomplete and I take your happiness seriously, so please feel free to submit issues and suggestions.

📌 Roadmap

Dates presented here are tentative and subject to change

gantt
dateFormat  YYYY-MM-DD
title Sociium Roadmap
excludes weekdays 2022-05-11

section Frontend
Design           :done,    des1, 2022-04-06,2022-04-20
Development      :done,    dev1, 2022-04-13,2022-05-01
Testing          :done,    test1, 2022-04-20,2022-05-07

section Backend
Authentication               :active,  des2, 2022-04-09, 2022-05-01
Comments                    :active,  des3, 2022-04-16, 2022-05-04
Email                       :active,  des4, 2022-04-23, 2022-05-11
Messages                   :active,  des5, 2022-04-30, 2022-05-17
News Feed                   :active,  des6, 2022-05-04, 2022-05-24
Tagging                   :active,  des7, 2022-05-11, 2022-05-28
Database                     :active,  des3, 2022-04-16, 2022-05-07


section Deployment
K8s               :         des4, after des3, 5d
Helm              :         des5, after des4, 5d
Terraform         :         des6, after des5, 5d

Loading

💎 Contributing

Want to contribute? What a chad move!

I'm always open to ideas and suggestions. If you find/have a suggestion, please submit an issue so we can track it properly and get to work on it.

If you'd like to contribute your suggested change please submit a pull request! This project follows the Git Flow branching model. Essentially, once you pull the code, create a branch for your change and commit it. Once that's done you ca submit a pull request to then be reviewed and merged later. This generally promotes greater happiness and joy for all collaborators.