/portaler-core

Monorepo for Portaler, a mapping tool for Albion Online

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

Portaler has been moved to community development

Portaler logo

An Albion Online Avalonian Roads shared mapping tool

discord

Looking for Contributors

I don't have as much time to keep up with this as when I first built it. If you're a developer or a budding developer, I would love to have your help!

Get Setup Developing!

Take a look at the project board here: Portaler Project

Fork the Repo & Submit PRs! Lets do this people. As of this writing, Portaler supports over 20,000 unique users a month across 357 servers and we could probably grow to even larger than that! It's a good project to work on if you're looking for an open source project to contribute to. I look for good code quality and solid practices. We run on barely any hardware and I want to keep it that way.

Unique Visitors
Servers

I (mawburn) love mentoring developers, so don't be afraid to ask "dumb" questions in our Discord channel #contributing, because we all start somewhere and I probably haven't documented things that well. I'm more than open to helping people learn JS/TS/Node/React/whatever, so if you don't have direct experience here no worries! This is your time to learn.


Contents


What it is

Portaler is a mapping tool for Avalonian Roads in Albion Online, that provides real time private data to your guild or alliance. It is fully Albion TOS compliant, because every user action is completely manual and nothing is automatically pulled or scraped from the Albion client or network packets. This tool simply provides a clean way for guilds/alliances share roads mapping internally.

The data we use to populate information is collected from Albion Data Project.

Screenshot

Running

There is a full Self-hosting Guide here, but a simple version can be found below.

If you would like to run the project on your own server, we provide DockerHub images and you can find a docker-compose.yml file in the docker folder. If you would like to just run the project, you do not need to build the docker files contained in the ./docker folder, just simply update the .env.example file with your variables, the variables in the docker-compose.yml and run:

docker-compose up -d

To setup your .env files with keys, follow the Github Token instructions here and the Discord instructions here.

Links to our DockerHub images:

Development

Click here for Development Setup