Skip to content

SpiritAxolotl/spax.zone

Repository files navigation

spax.zone

a webbed site for a webbed creachure[citation needed]

spax.zone

This is where I host most of the things I've made! The only dependency I use is node.js for building parts of the site before deployment.

spax.zone is registered with porkbun and hosted with cloudflare pages' free plan. Here are the build instructions and the redirects, but the tl;dr is everything in /html/ and /tests/ gets moved into the root directory, relevant javascript files (for node.js) are run, and SCSS is compiled to raw css.

development

For local development with live reload:

# Build and start dev server with automatic reload on file changes
npm run dev-watch

# Or just build once and start dev server
npm run dev

# Standard build
npm run build

The dev-watch command watches source directories (html, js, scss, css, data) and automatically rebuilds and reloads your browser when files change.

subdomains

spax.zone has a few subdomains

contributing

Contributions are welcome! Just please format things like how I do until I set up a prettier.

The only thing this project requires is node.js. Make sure you have it installed in the commandline by running node -v, and install all dependencies with npm i.

For everything:

  • two-space indentation (with spaces not tabs)
  • no trailing whitespace on lines with code
  • empty lines should have whitespace up to the indentation before that line

For javascript:

  • semicolons everywhere that warrants one
  • camelCase
  • const arrow functions (=>) instead of functions (generators are exempt since the syntax is unsupported)
  • doublequotes (") or backticks (`), prefering backticks if they're more useful
  • a space in between keywords like if else
  • forgo curly brackets ({}) for single-line if/else/for/while statements
  • client-side javascript files go in /js
  • server-side javascript files (meant to be run with node) go in /scripts

For css/scss:

  • NO sass. only scss
  • try to keep selectors on a single line, only using linebreaks if they get too long
  • single space between selectors and curly brackets ({})

For html:

  • id and class case is dependent on the file. stick to the case that the file uses
  • idk man just make it look clean

development

# Build and start dev server with automatic reload on file changes
npm run dev-watch

# Or just build once and start dev server
npm run dev

# Standard build
npm run build

The dev-watch command watches source directories (html, js, scss, css, data) and automatically rebuilds and reloads the browser tabs when files change.

license

No license! I reserve the rights to all of my code. Please ask me for permission before you use things I made unless you have the intention of contributing. You can find my contacts on my main github profile.
Temmie Chang allows for fanart and fanworks, but there's still gray area regarding the use of her assets. I would assume she is fine with them being used in non-commercial works, but I will happily take the assets down if she requests so. See her official statement on this.

credits

I want to thank everyone who either directly or indirectly helped me make my website.
In no particular order:

  • Mathew
  • CalmBubbles
  • 1LikeBananas
  • Zvitorep
  • HeySora
  • Sudospective
  • wavebeem
  • oatmealine
  • niko
  • marbelynrye
  • lostdusty
  • cefqrn
  • jj
  • norom
  • amber

And thank you for reading!
-Spax

About

spax's webbed site

Topics

Resources

Stars

Watchers

Forks

Contributors 10