inex/index.community
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
163 commits 1 branch 21 tags 61 MiB
Elixir 56.9%
TypeScript 39.2%
Java 2.5%
HTML 0.8%
Dockerfile 0.4%
Other 0.1%
Go to file
Tao Bojlén 2cae5dccbf check robots.txt for permission to crawl
2019-07-19 20:00:28 +00:00
.vscode frontend/cytoscape feature parity 2019-07-19 18:19:53 +00:00
backend check robots.txt for permission to crawl 2019-07-19 20:00:28 +00:00
frontend frontend/cytoscape feature parity 2019-07-19 18:19:53 +00:00
gephi frontend/cytoscape feature parity 2019-07-19 18:19:53 +00:00
.dokku-monorepo fix backend app name in .dokku-monorepo 2019-07-14 13:12:35 +01:00
.gitignore frontend/cytoscape feature parity 2019-07-19 18:19:53 +00:00
.gitlab-ci.yml Update .gitlab-ci.yml 2019-07-18 11:03:22 +00:00
BILL-OF-MATERIALS.md add sigmajs to bill of materials 2019-04-30 18:23:20 +01:00
CHANGELOG Add CHANGELOG 2019-07-13 19:02:29 +00:00
docker-compose.yml consolidate into one docker-compose.yml 2019-07-14 14:40:35 +01:00
example.env refactor/elixir backend 2019-07-14 11:47:06 +00:00
LICENSE use AGPL (#32) 2019-02-20 13:45:09 +00:00
netlify.toml Hide insular instances 2019-07-18 20:05:16 +00:00
README.md frontend/cytoscape feature parity 2019-07-19 18:19:53 +00:00
screenshot.png Replace screenshot.png 2019-04-17 09:52:10 +00:00

README.md

fediverse.space 🌐

The map of the fediverse that you always wanted.

Read the latest updates on Mastodon: @fediversespace

A screenshot of fediverse.space

  1. Requirements
  2. Running it
  3. Commands
  4. Privacy
  5. Acknowledgements

Requirements

Though dockerized, backend development is easiest if you have the following installed.

  • For the scraper + API:
    • Elixir
    • Postgres
  • For laying out the graph:
    • Java
  • For the frontend:
    • Node.js
    • Yarn

Running it

Backend

  • cp example.env .env and modify environment variables as required
  • docker-compose build
  • docker-compose up -d phoenix
    • if you don't specify phoenix, it'll also start gephi which should only be run as a regular one-off job

Frontend

  • cd frontend && yarn install
  • yarn start

Commands

Backend

./gradlew shadowJar compiles the graph layout program. java -Xmx1g -jar build/libs/graphBuilder.jar runs it. If running in docker, this means you run

  • docker-compose build gephi
  • docker-compose run gephi java -Xmx1g -jar build/libs/graphBuilder.jar lays out the graph

Frontend

  • yarn build creates an optimized build for deployment

Privacy

This project doesn't crawl personal instances: the goal is to understand communities, not individuals. The threshold for what makes an instance "personal" is defined in the backend config and the graph builder SQL.

Acknowledgements

NLnet logo

Many thanks to NLnet for their support and guidance of this project.