Skip to content

Latest commit

 

History

History
90 lines (72 loc) · 2.54 KB

README.md

File metadata and controls

90 lines (72 loc) · 2.54 KB
Raw


Splashcat

Splashcat is an award-winning service to track Splatoon 3 battles. Built upon Django, htmx, _hyperscript, and Tailwind CSS.

How to contribute

Thank you for taking the time to contribute to Splashcat! We appreciate your help. There are multiple ways you can help:

Getting Started

Required Dependencies: Python, Poetry & Node.js + NPM

  1. Fork the repository
  2. Clone the repo: 
    git clone https://github.com/your-username/splashcat.git
  3. cd into the directory: 
    cd *file path*
  4. Install dependencies: 
    poetry install
npm install
npx update-browserslist-db@latest
npm run build
  5. Run the website:
    macOS/Linux: 
    poetry shell
./manage.py runserver
    Windows: 
    poetry shell
python manage.py runserver

Contributing to the codebase

  1. Create a branch for your feature or fix: 
    git checkout -b myfeature
  2. Commit your changes: 
    git commit -m "Description of the change"
  3. Push to the branch: 
    git push origin myfeature
  4. Submit a pull request.

Reporting Bugs

If you've found a bug in Splashcat please report it! If it's a security vulnerability please contact [email protected] or use GitHub's tools for reporting security issues. Do not use a public GitHub issue.

Donating

Sponsoring me will support Splashcat and its server costs. Getting the $5+ monthly tier also gives you some little additional features in Splashcat! For more details, see https://splashcat.ink/sponsor/.

Contact

There's a Splashcat Discord server at https://discord.gg/JPFwvbSWMS and GitHub Discussions are available at https://github.com/orgs/splashcat-ink/discussions.

License

Splashcat is licensed under the terms of the AGPL-3.0 license