inex/index.community
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
62 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 Bror Bojlén 80c3a311b0
update README
2019-02-20 16:49:45 +00:00
backend docker-ise backend 2019-02-20 16:18:12 +00:00
config docker-ise backend 2019-02-20 16:18:12 +00:00
frontend Highlight selected instance (#21) 2018-12-06 18:48:32 +00:00
.gitignore docker-ise backend 2019-02-20 16:18:12 +00:00
docker-compose.production.yml docker-ise backend 2019-02-20 16:18:12 +00:00
docker-compose.yml docker-ise backend 2019-02-20 16:18:12 +00:00
example.env docker-ise backend 2019-02-20 16:18:12 +00:00
LICENSE use AGPL (#32) 2019-02-20 13:45:09 +00:00
README.md update README 2019-02-20 16:49:45 +00:00

README.md

fediverse.space

fediverse.space is a tool to explore instances in the fediverse 🌐

Requirements

  • For everything:
    • Docker
    • Docker-compose
  • For the scraper + API:
    • Python 3
  • For laying out the graph:
    • Java
  • For the frontend:
    • Yarn

Running it

Backend

  • cp example.env .env and modify environment variables as required
  • docker-compose build
  • docker-compose up -d

Frontend

  • cd frontend && yarn install
  • yarn start

Commands

Backend

  • python manage.py scrape scrapes the entire fediverse
  • python manage.py build_graph uses this information to lay out a graph

To run in production, use docker-compose -f docker-compose.yml -f docker-compose.production.yml instead of just docker-compose.

Frontend

  • yarn build to create an optimized build for deployment