OurSpace/README.md

![Version](https://img.shields.io/badge/version-0.0.1-blue.svg?style=for-the-badge)
![Status](https://img.shields.io/badge/status-active-green.svg?style=for-the-badge)
![License](https://img.shields.io/badge/license-GPLv3-lightgrey.svg?style=for-the-badge)
![ActivityPub](https://img.shields.io/badge/protocol-ActivityPub-orange.svg?style=for-the-badge)
![Contributors](https://img.shields.io/github/contributors/0xd011f4ce/OurSpace?style=for-the-badge)
![Forks](https://img.shields.io/github/forks/0xd011f4ce/OurSpace?style=for-the-badge)
![Stargazers](https://img.shields.io/github/stars/0xd011f4ce/OurSpace?style=for-the-badge)
![Issues](https://img.shields.io/github/issues/0xd011f4ce/OurSpace?style=for-the-badge)

<br>

<div align="center">
  <h3 align="center">OurSpace</h3>

  <p align="center">A decentralised clone of MySpace based in the ActivityPub protocol.</p>
</div>

<details>
  <summary>Table of Contents</summary>

  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li>
      <a href="#todo">TODO</a>
    </li>
  </ol>
</details>

## About The Project

![](img/OurSpaceHome.png)

**OurSpace** is a decentralised social networking platform inspired by the early concepts of MySpace but built using the ActivityPub protocol for enhanced privacy and interoperability. The goal of OurSpace is to provide users with a space to express themselves, share content, and connect with others in a federated environment that prioritises user privacy and data ownership.

### Built With

- ![Laravel](https://img.shields.io/badge/Laravel-v10-FF2D20?style=for-the-badge&logo=laravel&logoColor=white)
- ![PHP](https://img.shields.io/badge/PHP-v8-777BB4?style=for-the-badge&logo=php&logoColor=white)
- ![Redis](https://img.shields.io/badge/redis-%23DD0031.svg?style=for-the-badge&logo=redis&logoColor=white)

## Getting Started

OurSpace is meant to be easy to set up and run on your own server. Below are the steps to get started with OurSpace.

### Prerequisites

TODO: write this

### Installation

TODO: Write this

## TODO:

For a list of planned features and improvements, please refer to the [TODO](TODO) file.