-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #317 from Bentheminernz/readme
UI Fixes & ReadMe
- Loading branch information
Showing
10 changed files
with
315 additions
and
203 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,90 @@ | ||
# splashcat | ||
<h1 align='center'> | ||
<img src="https://raw.githubusercontent.com/splashcat-ink/splashcat/refs/heads/main/static/images/judd-pride.png" width="150"> | ||
<br> | ||
<b>Splashcat</b> | ||
</h1> | ||
|
||
[Splashcat](http://splashcat.ink "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](#getting-started) | ||
- [Contributing to the codebase](#contributing-to-the-codebase) | ||
- [Reporting bugs](#reporting-bugs) | ||
- [Donating](https://github.com/sponsors/catgirlinspace) | ||
|
||
## Getting Started | ||
|
||
Required | ||
Dependencies: [Python](https://www.python.org/downloads/ "Python"), [Poetry](http://python-poetry.org/docs "Poetry") & [Node.js + NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm "NPM") | ||
|
||
1. Fork the repository | ||
2. Clone the repo: | ||
```bash | ||
git clone https://github.com/your-username/splashcat.git | ||
``` | ||
3. cd into the directory: | ||
```bash | ||
cd *file path* | ||
``` | ||
4. Install dependencies: | ||
```bash | ||
poetry install | ||
npm install | ||
npx update-browserslist-db@latest | ||
npm run build | ||
``` | ||
5. Run the website: | ||
<br> | ||
macOS/Linux: | ||
```bash | ||
poetry shell | ||
./manage.py runserver | ||
``` | ||
Windows: | ||
```bash | ||
poetry shell | ||
python manage.py runserver | ||
``` | ||
|
||
## Contributing to the codebase | ||
|
||
1. **Create a branch** for your feature or fix: | ||
```bash | ||
git checkout -b myfeature | ||
``` | ||
2. **Commit your changes**: | ||
```bash | ||
git commit -m "Description of the change" | ||
``` | ||
3. **Push** to the branch: | ||
```bash | ||
git push origin myfeature | ||
``` | ||
4. **Submit a pull request**. | ||
|
||
## Reporting Bugs | ||
|
||
If you've found a bug in Splashcat | ||
please [report it! ](https://github.com/splashcat-ink/splashcat/issues/new "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 ](https://github.com/splashcat-ink/splashcat/blob/main/LICENSE "AGPL-3.0 license ") | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.