The jollywhoppers homepage 🍬🍔 forked from jollywhoppers.com/jollywhoppers.com

README.md

Jolly Whoppers #

A modern redesign and revitalisation of the jollywhoppers.com website, built with SvelteKit and TypeScript.

About #

Jolly Whoppers is an informal coding group founded by xan.lol. This project represents a complete refresh of our outdated website, bringing it into the modern web era with improved design, performance, and maintainability.

Tech Stack #

  • Framework: SvelteKit (v2)
  • Language: TypeScript
  • Svelte: v5
  • Build Tool: Vite

Getting Started #

Prerequisites #

  • Node.js 18+ (or latest LTS)
  • npm, pnpm, or yarn

Clone the Repository #

# SSH
git clone git@tangled.org:jollywhoppers.com/jollywhoppers.com

# HTTPS
git clone https://tangled.org/jollywhoppers.com/jollywhoppers.com

Installation #

npm install

Development #

Start the development server:

npm run dev

Or open the app in a new browser tab automatically:

npm run dev -- --open

The development server will be available at http://localhost:5173 (or another port if 5173 is in use).

Available Scripts #

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run preview - Preview production build locally
  • npm run check - Run TypeScript and Svelte checks
  • npm run check:watch - Run checks in watch mode
  • npm run format - Format code with Prettier
  • npm run lint - Check code formatting

Building for Production #

npm run build

The production build will be created in the build directory. Preview it locally with:

npm run preview

Note: You may need to install an adapter for your specific deployment target.

Contributing #

Contributions are welcome! If you're a member of Jolly Whoppers or would like to contribute:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License #

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See the LICENSE file for details.

Credits #

  • Founder/Owner: xan.lol
  • Contributors: Members of the Jolly Whoppers coding group

Part of the Jolly Whoppers informal coding group