https://github.com/faervan/albion-killarchive

Educational project to mimic murderledger.com
https://github.com/faervan/albion-killarchive

albion albion-online albiononline rails ruby ruby-on-rails

Last synced: 3 months ago
JSON representation

Educational project to mimic murderledger.com

• Host: GitHub
• URL: https://github.com/faervan/albion-killarchive
• Owner: Faervan
• License: gpl-3.0
• Created: 2024-07-20T12:01:28.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-13T13:44:55.000Z (3 months ago)
• Last Synced: 2024-09-23T20:48:07.258Z (3 months ago)
• Topics: albion, albion-online, albiononline, rails, ruby, ruby-on-rails
• Language: Ruby
• Homepage: https://albion.killarchive.fun/
• Size: 320 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# What?

Trying to creae a murderledger clone with some additional features, as an educational project.

# Where?

https://albion.killarchive.fun/

# How?

Using Ruby on Rails for everything.

## Fetching events

- Fetching gets scheduled in `config/initializers/scheduler.rb`

- Events get analyzed and fed into the PostgreSQL database by the services in `app/services/event_handler_service/`

## Showing events

Just the Rails way.

# Contributing

This project needs a nice frontend design using HTML/CSS/Javascript and a lot of backend stuff for fetching and feeding from Albions API.

If you want to contribute to that, please feel free to open a PR for minor fixes or contact me via [Discord](https://discord.com/users/738658712620630076) to coordinate bigger changes/contributes.

# Installing it locally

You can clone this Repo and host the project locally:

## Dependencies

- `ruby` - currently 3.2.4 - consider installing via https://rvm.io/ or [via package manager if you're on Arch Linux](https://archlinux.org/packages/extra-staging/x86_64/ruby/)

- `git` - obviously

- `postgresql` - currently 16.3

- `rails` - `gem install rails`

- `gems` - `bundle install --gemfile Gemfile`

- `redis` - see [redis.io](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/)

- `ImageMagick` - see [imagemagick.org](https://imagemagick.org/script/download.php)

## PostgreSQL

PostgreSQL needs to be setup, that can be different depending on environment...

Look at

- [Arch Wiki](https://wiki.archlinux.org/title/PostgreSQL)

- [Debian Wiki](https://wiki.debian.org/PostgreSql)

When it comes to creating a user, do `createuser --interactive`, enter your username as role name and grant database creation perms, superuser not required.

## Running

In the `albion-killarchive` directory, do:

```

bin/rails db:create

bin/rails db:migrate

```

and then start the Server via

```

bin/rails server

```

and the job executing (to fetch events) with:

```

bundle exec sidekiq -q default,5 -q low_priority,2

```

You *should* be able to open http://localhost:3000/ in your browser and see stuff.

# Credits

to [uxwing](https://uxwing.com/skull-red-icon/) for the favicon (`app/assets/images/favicon.svg`) as well as the pending-work icon (`app/assets/images/pending-work-icon.svg`)