From ddb560d51043164c0c66a10d926e617a71b63766 Mon Sep 17 00:00:00 2001 From: Ellie Date: Wed, 18 Feb 2026 05:28:24 +0000 Subject: [PATCH 1/3] Update README.md --- .env.example | 4 ++++ README.md | 44 +++++++++++++++++++++----------------------- 2 files changed, 25 insertions(+), 23 deletions(-) create mode 100644 .env.example diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..03cc4dd --- /dev/null +++ b/.env.example @@ -0,0 +1,4 @@ +SECRET_KEY= + +# OpenAI API key, optional +OPENAI_API_KEY= diff --git a/README.md b/README.md index 15acadc..4ba0a95 100644 --- a/README.md +++ b/README.md @@ -22,33 +22,31 @@ 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 +2. Clone the repo and change directory: + ```sh git clone https://github.com/your-username/splashcat.git + cd splashcat + ``` +3. Copy `.env.example` to `.env` and add required environment variables + To generate a `SECRET_KEY`: + ```sh + openssl rand -base64 50 | tr -dc 'a-zA-Z0-9!@#$%^&*(-_=+)' | head -c 50 ``` -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 + ```sh + poetry install + npm install + npx update-browserslist-db@latest + ``` +5. Build the frontend CSS/JS: + ```sh + npm run build + poetry run python manage.py collectstatic + ``` +6. Run the server: + ```sh + poetry run python manage.py runserver ``` -5. Run the website: -
- macOS/Linux: - ```bash - poetry shell - ./manage.py runserver - ``` - Windows: - ```bash - poetry shell - python manage.py runserver - ``` ## Contributing to the codebase From eb60b9a14b84819046cdb101abe6888453bf6a9f Mon Sep 17 00:00:00 2001 From: Ellie Date: Wed, 18 Feb 2026 16:21:27 +0000 Subject: [PATCH 2/3] Update README.md, .env.example --- .env.example | 2 ++ README.md | 19 ++++++++++--------- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/.env.example b/.env.example index 03cc4dd..575c22f 100644 --- a/.env.example +++ b/.env.example @@ -1,4 +1,6 @@ SECRET_KEY= +DEBUG=True + # OpenAI API key, optional OPENAI_API_KEY= diff --git a/README.md b/README.md index 4ba0a95..b4b46c3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -

- +

+
Splashcat

@@ -18,8 +18,10 @@ Thank you for taking the time to contribute to Splashcat! We appreciate your hel ## 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") +Required dependencies: +[Python](https://www.python.org/downloads/), +[Poetry](https://python-poetry.org/docs) & +[Node.js + npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). 1. Fork the repository 2. Clone the repo and change directory: @@ -43,7 +45,7 @@ Dependencies: [Python](https://www.python.org/downloads/ "Python"), [Poetry](htt npm run build poetry run python manage.py collectstatic ``` -6. Run the server: +6. Run the web server: ```sh poetry run python manage.py runserver ``` @@ -62,12 +64,12 @@ Dependencies: [Python](https://www.python.org/downloads/ "Python"), [Poetry](htt ```bash git push origin myfeature ``` -4. **Submit a pull request**. +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! ") +please [report it!](https://github.com/splashcat-ink/splashcat/issues/new) If it's a security vulnerability please contact splashcat@rosalina.saige.ink or use GitHub's tools for reporting security issues. Do **not** use a public GitHub issue. @@ -84,5 +86,4 @@ 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 ") - +the [AGPL-3.0 license](https://github.com/splashcat-ink/splashcat/blob/main/LICENSE). From 187620b3946d3a71b3c726983eb547054f091fed Mon Sep 17 00:00:00 2001 From: Ellie Date: Wed, 18 Feb 2026 16:28:32 +0000 Subject: [PATCH 3/3] HTTPS link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b4b46c3..8a7bec6 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Splashcat -[Splashcat](http://splashcat.ink "Splashcat") is an award-winning service to track Splatoon 3 battles. Built upon +[Splashcat](https://splashcat.ink) is an award-winning service to track Splatoon 3 battles. Built upon Django, htmx, _hyperscript, and Tailwind CSS. ## How to contribute