Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danieletorelli/golem-x
Basic Twitter / X features like following, posting, user profile and timeline designed as distributed WebAssembly component architecture for Golem OSS / Golem Cloud
https://github.com/danieletorelli/golem-x
golem golem-cloud golem-hackathon golemcloud webassembly
Last synced: about 1 month ago
JSON representation
Basic Twitter / X features like following, posting, user profile and timeline designed as distributed WebAssembly component architecture for Golem OSS / Golem Cloud
- Host: GitHub
- URL: https://github.com/danieletorelli/golem-x
- Owner: danieletorelli
- License: apache-2.0
- Created: 2024-08-31T12:47:40.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-10-16T04:10:42.000Z (2 months ago)
- Last Synced: 2024-10-19T19:15:47.008Z (2 months ago)
- Topics: golem, golem-cloud, golem-hackathon, golemcloud, webassembly
- Language: Rust
- Homepage:
- Size: 103 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Golem X
=======
Golem X is a project meant to run on [Golem Cloud](https://golem.cloud) that aims to implement some basic social
networking features like posting, following, fetch user profile, tweets and timeline.
Each component in the architecture exposes a WebAssembly interface that can be called by other components.
Setup
-----
The project requires:
- [Rust](https://www.rust-lang.org/tools/install)
- [Cargo Component](https://github.com/bytecodealliance/cargo-component)
```bash
cargo install cargo-component
```
- [Cargo Make](https://github.com/sagiegurari/cargo-make)
```bash
cargo install cargo-make
```
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/)
- [Golem CLI](https://github.com/golemcloud/golem/releases)
- You can download the latest binary from the GitHub releases page
- Or you can build it:
```bash
cargo install golem-cloud-cli --features universal
```
Note: Requires protobuf installed on your system
Run
---
1. Spin up Golem OSS (optional, to run locally):
```bash
docker compose --env-file docker.env up -d
```
2. Building is as simple as:
```bash
./update_components.sh build
```
This script will make sure to build, create the components and the router worker and load the API definition.
3. Call the API to:
1. Create a user:
```bash
source ./api_calls.sh
create_user "Bob"
{ "message": "Success", "status": 200 }
```
2. Get the user profile:
```bash
source ./api_calls.sh
get_profile 0
{ "status": 200, "user": { "user-id": 0, "username": "Bob", "followers": [], "following": [] } }
```
Test
----
To run unit tests, execute:
```bash
cargo test --all
```