Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zeropingheroes/lanager
LAN party management web application
https://github.com/zeropingheroes/lanager
gaming lanparty steam
Last synced: about 1 month ago
JSON representation
LAN party management web application
- Host: GitHub
- URL: https://github.com/zeropingheroes/lanager
- Owner: zeropingheroes
- License: agpl-3.0
- Created: 2013-11-03T15:52:28.000Z (about 11 years ago)
- Default Branch: stable
- Last Pushed: 2024-09-17T21:42:23.000Z (3 months ago)
- Last Synced: 2024-09-18T02:32:45.784Z (3 months ago)
- Topics: gaming, lanparty, steam
- Language: PHP
- Homepage:
- Size: 40.6 MB
- Stars: 121
- Watchers: 17
- Forks: 31
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Authors: AUTHORS.txt
Awesome Lists containing this project
- awesome-lanparty-software - LANager
README
LANager
=======
| Stable Branch | Develop Branch |
|-------------------------------------------------:|---------------------------------------------------:|
| [![Dusk][duskStableImg]][duskStableUrl] | [![Dusk][duskDevelopImg]][duskDevelopUrl] |
| [![StyleCI][styleciStableImg]][styleciStableUrl] | [![StyleCI][styleciDevelopImg]][styleciDevelopUrl] |
[duskStableImg]:https://github.com/zeropingheroes/lanager/actions/workflows/run-dusk.yml/badge.svg?branch=stable
[duskStableUrl]:https://github.com/zeropingheroes/lanager/actions/workflows/run-dusk.yml
[styleciStableImg]:https://github.styleci.io/repos/14088050/shield?branch=stable
[styleciStableUrl]:https://github.styleci.io/repos/14088050?branch=stable
[duskDevelopImg]:https://github.com/zeropingheroes/lanager/actions/workflows/run-dusk.yml/badge.svg?branch=develop
[duskDevelopUrl]:https://github.com/zeropingheroes/lanager/actions/workflows/run-dusk.yml
[styleciDevelopImg]:https://github.styleci.io/repos/14088050/shield?branch=develop
[styleciDevelopUrl]:https://github.styleci.io/repos/14088050?branch=develop
LANager is a web application designed to make [LAN parties](https://en.wikipedia.org/wiki/Lan_party)
more enjoyable for attendees and organisers alike.
## Features
### Encourage socialising & participation
* **Games being played** - by your LAN's attendees, updated every minute from Steam
* **Events timetable** - so your attendees know what's on at the LAN
* **Achievements** - created by you and awarded to attendees
* **Attendee profiles** - with a link to their Steam profile, and their gameplay history at the LAN
* **Games in common** - when viewing another attendee's profile
* **Games recently played** - showing the top games most recently played by attendees at the LAN
### Broadcast useful information
* **Slides** - showing games attendees are currently playing, and current and upcoming events, for TVs or
projectors around your venue
* **Guides** - written by you, to help attendees learn about things like venue facilities, rules, or gameplay guides
* **Links** - to other websites, such as your organisation's website, or a game statistics page
## Requirements
* Internet access
* [Docker Engine](https://docs.docker.com/engine/install/#server)
* [Docker Compose](https://docs.docker.com/compose/install/)
## Setup
1. Clone the `lanager-docker-compose` project:
```bash
git clone https://github.com/zeropingheroes/lanager-docker-compose
```
2. Copy `.env.example` to a new file named `.env`:
```bash
cd lanager-docker-compose
cp .env.example .env
```
3. Open the environment configuration file in a text editor:
```bash
nano .env
```
4. Set the following configuration items:
1. Set `APP_KEY` to `base64:` followed by
a [randomly generated 32 character base64 string](https://www.google.com/search?q=random+base64)
2. Set `APP_URL` to the URL you will access LANager through, without a trailing slash,
e.g. `https://example.com`
3. Set `APP_TIMEZONE` to your
location's [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)
4. Set `STEAM_API_KEY` to your [Steam API Key](http://steamcommunity.com/dev/apikey)
5. Set `DB_PASSWORD` to a [randomly generated password](https://www.google.com/search?q=password+generator)
6. Set `DB_ROOT_PASSWORD` to a different randomly generated password
5. Bring up the application:
```bash
docker-compose up --detach
```
6. Check the application's status:
```bash
docker ps --filter name=lanager
```
7. When the container status shows `Up x minutes (healthy)`, initialise the database:
```bash
./initialise-database.sh
```
LANager should now be accessible at http://localhost, or at the URL you specified in `APP_URL`, providing you've
created a corresponding DNS `A` record for the Docker host's IP address, and allowed ports `80` and `443` through
the Docker host's firewall.
## Troubleshooting
- Run `docker-compose down --rmi local --volumes` to delete the database data and LANager container image, and then
retry the setup steps above
- Edit your `.env` file and enable debugging:
```bash
APP_ENV=staging
APP_DEBUG=true
```
**Important:** Remove these lines after troubleshooting to avoid leaking sensitive data
If you get stuck, [create an issue](https://github.com/zeropingheroes/lanager/issues) with the details of what
you're experiencing:
- The commands you've run
- The output of `docker-compose up`
- The output of `docker logs lanager`
- Any errors displayed in your browser
## Getting started
To set up the LANager for your next LAN party, you need to create a LAN page, then add Events (such as scheduled games
or lunch breaks) and Guides (such as game rules) to that LAN page.
### Become a Super Admin
The LANager assigns the "Super Admin" role to the first account that logs into it, so make sure you log in as soon as
you have completed installation.
Super Admins can perform any action on the site, including assigning roles to other users.
### Create your LAN page
The first thing you need to do is to create a LAN page in the LANager. This process is the same whether your LAN party
is one day or multiple days. You need to do this before you can create an event schedule, publish any guides or award
achievements.
Log into the LANager, and go to ⚙ > **LANs**, then select the **+** button to go to the LAN page creation form. Enter
your LAN's details, and add a description with [Markdown formatting](https://en.wikipedia.org/wiki/Markdown#Example)
if you want to.
The LANager automatically adds anyone who logs into the LANager during the LAN party to the LAN's list of attendees.
For each attendee it displays the current LAN page, which contains the LAN's timetabled events, guides and attendees
list.
### Create Events & Guides
Once you have a LAN page for your LAN party, you can create Events and Guides to help attendees enjoy your party.
* **Events** are a useful way to timetable game tournaments, highlight big game sessions, schedule breaks and mealtimes,
and let people know when it's time to go home
* **Guides** are a useful way to provide people with the rules and download links to the games you're playing, to let
them know where the nearest shops and restaurants are, to provide a code of conduct for your event, and to communicate
any other information you think your guests might need.
From the LAN page, click the **+** button next to the **Events** and **Guides** headings to go to their creation forms.
#### Using links
You can use markdown-formatted links in LANs, guides and events. For example, you can write a single guide, and insert
a link to it on several event pages:
If you need any help, please contact one of our [tournament staff](/lans/4/guides/3)
Where possible, it's good practice to use relative links as demonstrated above, so that if you change your domain, the
links continue to work.
#### Using images
You can upload images to LAN pages, Events and Guides. To do this, follow these steps:
1. Below the "description" text box, select "upload images".
2. Upload the image you want to use.
3. Next to the image, select ⚙ > **Copy Markdown**
4. Paste the markdown into the guide, event or LAN's **description** field, in the location you want it to appear in the
text.
### Display slides
The slides feature allows you to display a looping slideshow of live data and useful info for your attendees, such as
which event is starting next, which games people are playing, and how to log into the LANager.
To display the slideshow, log in as an admin, and navigate to ⚙ > **LANs** > *(your LAN)* > **Slides**.
Load the slideshow on a big TV or projector so that attendees can see the info easily.
### Create and award Achievements
Click ⚙ > **Achievements** and then click the **+** button to create achievements that you can award to users.
To award an Achievement to an attendee, go to the navigation bar and select **Achievements**. This opens the list of
Achievements you have awarded to attendees of the current LAN. At the bottom of the page, choose the Achievement and the
attendee to award it to, then select **Award**.
### Customise the navigation bar
Click ⚙ > **Navigation** to customise the links shown on the navigation bar. You can link to pages on the LANager or
to third-party sites, organise the links into drop-down menus, and choose the order that the links appear in the navbar
or dropdown.
## Backup
Run `./backup.sh` to back up LANager's configuration, database data and uploaded images.
### Restore a backup
Run `./backup-restore.sh ` to restore a backup.
## Development
### Development environment setup
1. Follow the steps from the *Setup* section above
2. Stop the running containers
```bash
docker-compose down
```
3. Check out the development branch of `lanager-docker-compose`
```bash
cd lanager-docker-compose
git checkout develop
```
4. Edit `lanager-docker-compose/.env` and add the following lines:
```bash
APP_ENV=local
APP_DEBUG=true
```
5. In a directory outside of `lanager-docker-compose`, clone the `lanager` repository:
```bash
git clone --branch develop https://github.com/zeropingheroes/lanager
```
6. Install [`composer`](https://getcomposer.org/download/) on your host computer
7. From the `lanager` directory, install composer dependencies:
```bash
composer install --no-scripts
```
8. Set an environment variable with the path to where you cloned the `lanager` repository (without a trailing slash)
```bash
export PATH_TO_LANAGER=/path/to/lanager
```
9. From the `lanager-docker-compose` directory, run `envsubst` to substitute in the path to lanager into
`docker-compose.override.yml`:
```bash
envsubst < docker-compose.override.yml.example > docker-compose.override.yml
```
10. Start the containers
```bash
docker-compose up --detach
```
11. After a minute or so, visit `http://localhost`
The container will run the code from your host computer, rather than the static copy of the code in the container's
image, so any changes you make to the files in the project directory (except for the `storage/` directory)
will be seen by the running containers.
### Start and stop the development environment
To stop the development environment run `docker-compose stop`.
When you're ready to start developing again run `docker-compose start`.
### Destroy the development environment
To destroy the development environment and all volumes that store lanager data, run:
```bash
docker-compose down --volumes
```
Follow the setup steps above to get a fresh development environment.
### Enable pre-commit hooks
To automatically check for and fix problems with your code before you commit:
1. Install [pre-commit](https://pre-commit.com/)
2. Install [PHP Codesniffer & Code beautifier](https://github.com/squizlabs/PHP_CodeSniffer)
3. From the `lanager/` directory, run `pre-commit install`
To check your code, run `pre-commit run --all-files` or attempt to run `git commit`
### Recompiling JavaScript & CSS assets
To recompile JavaScript & CSS assets, from the `lanager` directory, run:
1. `docker run -it --rm -v "$PWD":/var/www/html -w /var/www/html node:14-alpine npm install`
2. `docker run -it --rm -v "$PWD":/var/www/html -w /var/www/html node:14-alpine npm run dev`
To recompile whenever changes to files are detected, run:
1. `docker run -it --rm -v "$PWD":/var/www/html -w /var/www/html node:14-alpine npm run watch-poll`
To recompile minified versions suitable for committing, run:
1. `docker run -it --rm -v "$PWD":/var/www/html -w /var/www/html node:14-alpine npm run prod`
### Running tests
Before submitting pull requests, please run the functional test suite to check your changes don't break existing
functionality.
Run `docker exec -it lanager php artisan dusk` to run LANager's browser test suite.
## Feedback & Contributions
* Found a bug? Got a great feature idea? Post it to
the [issue tracker](https://github.com/zeropingheroes/lanager/issues)!
* Want to contribute?
* [Fork the project](https://github.com/zeropingheroes/lanager/fork) and add the features you want to see.
* Work on new features / bug fixes in the [issue tracker](https://github.com/zeropingheroes/lanager/issues).
* If you're really hardcore, request commit access.
If you want to support the project in a non-technical way, we'd love it if you donated to us:
[](https://flattr.com/submit/auto?user_id=zeropingheroes&url=https%3A%2F%2Fgithub.com%2Fzeropingheroes%2Flanager)
Enjoy using the LANager!