README.md at main · danielmorrisey.com/jollywhoppers.com

forked from jollywhoppers.com/jollywhoppers.com
The jollywhoppers homepage 🍬🍔
jollywhoppers.com / README.md
at main 2.7 kB view raw view rendered
  1# Jolly Whoppers
  2
  3A modern redesign and revitalisation of the [jollywhoppers.com](https://jollywhoppers.com) website, built with SvelteKit and TypeScript.
  4
  5## About
  6
  7Jolly Whoppers is an informal coding group founded by [xan.lol](https://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.
  8
  9## Tech Stack
 10
 11- **Framework:** [SvelteKit](https://kit.svelte.dev/) (v2)
 12- **Language:** TypeScript
 13- **Svelte:** v5
 14- **Build Tool:** Vite
 15
 16## Getting Started
 17
 18### Prerequisites
 19
 20- Node.js 18+ (or latest LTS)
 21- npm, pnpm, or yarn
 22
 23### Clone the Repository
 24
 25```sh
 26# SSH
 27git clone git@tangled.org:jollywhoppers.com/jollywhoppers.com
 28
 29# HTTPS
 30git clone https://tangled.org/jollywhoppers.com/jollywhoppers.com
 31```
 32
 33### Installation
 34
 35```sh
 36npm install
 37```
 38
 39### Development
 40
 41Start the development server:
 42
 43```sh
 44npm run dev
 45```
 46
 47Or open the app in a new browser tab automatically:
 48
 49```sh
 50npm run dev -- --open
 51```
 52
 53The development server will be available at `http://localhost:5173` (or another port if 5173 is in use).
 54
 55## Available Scripts
 56
 57- `npm run dev` - Start development server
 58- `npm run build` - Build for production
 59- `npm run preview` - Preview production build locally
 60- `npm run check` - Run TypeScript and Svelte checks
 61- `npm run check:watch` - Run checks in watch mode
 62- `npm run format` - Format code with Prettier
 63- `npm run lint` - Check code formatting
 64
 65## Building for Production
 66
 67```sh
 68npm run build
 69```
 70
 71The production build will be created in the `build` directory. Preview it locally with:
 72
 73```sh
 74npm run preview
 75```
 76
 77> **Note:** You may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your specific deployment target.
 78
 79## Contributing
 80
 81Contributions are welcome! If you're a member of Jolly Whoppers or would like to contribute:
 82
 831. Fork the repository
 842. Create a feature branch (`git checkout -b feature/amazing-feature`)
 853. Commit your changes (`git commit -m 'Add some amazing feature'`)
 864. Push to the branch (`git push origin feature/amazing-feature`)
 875. Open a Pull Request
 88
 89## License
 90
 91This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See the [LICENSE](LICENSE) file for details.
 92
 93## Credits
 94
 95- **Founder/Owner:** [xan.lol](https://xan.lol)
 96- **Contributors:** Members of the Jolly Whoppers coding group
 97
 98## Links
 99
100- **Website:** [jollywhoppers.com](https://jollywhoppers.com)
101- **Repository:** [tangled.org/jollywhoppers.com/jollywhoppers.com](https://tangled.org/jollywhoppers.com/jollywhoppers.com)
102
103---
104
105Part of the Jolly Whoppers informal coding group