Skip to content

Commit

Permalink
refresh FS repo (#101)
Browse files Browse the repository at this point in the history
* update readme and badges

* delete diagram

* add w3f badge and adjust readme

* adjust size and position

* remove unused files

* adjusted the readme some more

* add w3f badge back

* changed from docker hub to ghcr registry
  • Loading branch information
ilhanu committed Jul 19, 2022
1 parent 6a9b11b commit 3afb64a
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 76 deletions.
7 changes: 0 additions & 7 deletions .envrc

This file was deleted.

49 changes: 31 additions & 18 deletions .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,38 @@ on:
tags:
- v0.0*

env:
IMAGE_NAME: fs-node

jobs:
docker:
runs-on: ubuntu-latest
permissions:
packages: write
contents: read

steps:
-
name: Set up QEMU
uses: docker/setup-qemu-action@v2
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v2
-
name: Login to DockerHub
uses: docker/login-action@v2
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
-
name: Build and push
uses: docker/build-push-action@v3
with:
push: true
tags: ilhanu/fs-node:latest
- uses: actions/checkout@v3

- name: Build image
run: docker build . --file Dockerfile --tag $IMAGE_NAME --label "runnumber=${GITHUB_RUN_ID}"

- name: Log in to registry
run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u $ --password-stdin

- name: Push image
run: |
IMAGE_ID=ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME
# Change all uppercase to lowercase
IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
# Strip git ref prefix from version
VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
# Strip "v" prefix from tag name
[[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
# Use Docker `latest` tag convention
[ "$VERSION" == "master" ] && VERSION=latest
echo IMAGE_ID=$IMAGE_ID
echo VERSION=$VERSION
docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
docker push $IMAGE_ID:$VERSION
37 changes: 0 additions & 37 deletions .vscode/tasks.json

This file was deleted.

23 changes: 9 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
<div align="center">
<a href="https://discord.gg/5u3dxE49V5">
<img alt="Discord" src="https://img.shields.io/discord/899662897003778139?label=Fair%20squares%20&logo=Discord&logoColor=red" />
</a>
<a href="https://twitter.com/FairSquares">
<img alt="Twitter Follow Fair Squares" src="https://twitter.com/FairSquares"/>
</a>
</div>


# Fair Squares (FS)
## Description
FS connects supply and demand of house-owners & renters and houses & investors. Our motive is that we want to create an affordable housing market. Investors of a house get a social return while renters can have cheaper housing.
# Fair Squares (FS) &middot; [![Twitter URL](https://img.shields.io/twitter/follow/fairsquares?style=social)](https://twitter.com/fairsquares) [![License](https://img.shields.io/github/license/fair-Squares/fair-squares)](https://github.com/Fair-Squares/fair-squares/blob/main/LICENSE) [![Discord](https://img.shields.io/badge/Discord-gray?logo=discord)](https://discord.gg/5u3dxE49V5)

It removes the financial barrier of investing in real estate for investors that don't have the means to fully invest in a house themselves. In between the end-users, there is coordination taking place between different stakeholders to achieve the desired outcome. This is where the runtime and the logic of all pallets come together, orchestrating while adhering to strict rules set for a equitable system.
<div align=center>
<img align=top src="https://fair-squares.nl/assets/fs_light.png" width=30%/>
<img align=top src="assets/img/web3_foundation_grants_badge_white.svg" width=40%/>
</div>
</br>

FS can be positions as a programmed DAO that has the financial tools housing-fund that is programmed to bid on houses as they have been succesfully onboarded. The onboarding is achieved by verfied actors such as a fullfilling tasks to get the truth on-chain. The real world actors the following real-world actors to fullfill tasks and get paid out by the digital society.
**Fair Squares** connects supply and demand of house-owners & renters and houses & investors. Our motive is that we want to create an more affordable housing market. Investors of the house get a social return while renters can have cheaper housing. We want to remove the financial barrier of investing in real estate for investors that don't have the means to fully invest in a house themselves for a social return. In between the end-users, there is coordination taking place between different stakeholders to achieve the desired outcome. This is where the runtime and the logic of all pallets come together, orchestrating while adhering to strict rules set for an equitable system. The orchestration towards an equitable housing market is configurable and governable by the stakeholders that are concerend with it and are willing to work for it.

We are zooming much more on the problem definition, stakeholders and the solution in our paper on our [website](https://fair-squares.nl/). To learn more and get in touch with us, please join our [discord channel FS](https://discord.gg/5u3dxE49V5)

Our current development is funded by [Web3 Foundation Grants Program](https://github.com/w3f/Grants-Program)

</br>

## Run & build
Expand All @@ -39,7 +35,6 @@ We added a [Dockerfile](https://github.com/Fair-Squares/fair-squares/blob/main/D
### Docker images
//


### Run in Docker in linux

First, install [Docker](https://docs.docker.com/get-docker/) and
Expand Down
Binary file removed assets/fs_works.jpeg
Binary file not shown.
1 change: 1 addition & 0 deletions assets/img/web3_foundation_grants_badge_white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3afb64a

Please sign in to comment.