What's Smash Map ?

Smash Map is an open source website under development, it's goal is to help smash players to find tournaments and other players around the world

Smash Map Features

Current Smash Map features

• World map to display events and registered users
• Event Browsing
• User's notifications to let users know when a tournament is happening near them
• Automatic event creation The Smash map database will automatically keep track of the next tournaments

Future features

• In real time notifications with WebSockets
• Event Calendar to get a better overview of what is happening around the world
• Manual event creation

In progress features

• Maintaining the site
• Bug fixes

Setup

Prerequisites

Make sure PHP, Composer, NodeJS and Docker are installed.

Note: Docker Compose is not included in the nix flake and must be installed separately.

Alternatively, use the provided nix flake for PHP/Composer/NodeJS:

nix develop

Note: Docker must still be installed separately as it is not included in the nix flake.

1. Install dependencies

npm install
composer install

2. Configure environment

cp .env.example .env

Fill in the .env file with your database credentials and other required values.

Note: Keep DB_USERNAME as root for development if you plan to use the provided Docker Compose.

3. Generate application key

php artisan key:generate

4. Setup Laravel IDE autocompletion (optional)

php artisan ide-helper:generate      # facade completions
php artisan ide-helper:models --nowrite  # model properties
php artisan ide-helper:meta          # meta file

5. Generate API documentation (optional)

php artisan scribe:generate

The documentation will be available at /docs once the development server is running.

6. Start the database Docker services

docker compose up -d

phpMyAdmin will be available at http://localhost:8080.

7. Set up database

Note: The first migration is expected to fail. This is because some character migrations depend on game data that is only created by the seeder.

php artisan migrate        # Fails - missing tables from seeder
php artisan db:seed        # Creates required tables
php artisan migrate        # Completes successfully
php artisan storage:link

8. Populate the database

php artisan setup
php artisan import-50-events-all-games

9. Run the development servers

npm run dev
php artisan serve

Smash map links

GitHub

Twitter

Discord

Website