README
➕ Svelte Adders
❓ What is this?
This is a community project of commands to add particular functionality to Svelte projects.
They are all composable, meaning that it should always be possible to run one after running any other command without something breaking (ideally). This should put an end to the boilerplate problem: too much or too little is included.
🧰 SvelteKit
SvelteKit is an alpha project now, but work is starting now so that there are good integrations for when it enters beta.
svelte-add/bulma: Add Bulma to your SvelteKit project
svelte-add/firebase-hosting: Add hosting on Firebase to your SvelteKit project
svelte-add/graphql: Add a GraphQL server to your SvelteKit project
svelte-add/mdsvex: Add mdsvex to your SvelteKit project
svelte-add/postcss: Add PostCSS to your SvelteKit project
svelte-add/tailwindcss: Add Tailwind CSS to your SvelteKit project
💡 Example
To migrate from sapper-firebase-typescript-graphql-tailwindcss-actions-template to SvelteKit, these commands can be run to recreate all the functionality:
# Use the official SvelteKit template
npm init svelte@next # Say yes to TypeScript preprocessing and select plain CSS
npx apply svelte-add/postcss
npx apply svelte-add/tailwindcss
npx apply svelte-add/graphql
npx apply svelte-add/firebase-hosting
# Actually, there's a limitation for right now that server functions like a GraphQL server
# aren't supported by svelte-add/firebase-hosting, but that could be solved later!
So, to exclude a feature you weren't using that was still included in the boilerplate anyway, don't run its corresponding command. Suppose you only wanted PostCSS and to host on Firebase, then drop the svelte-add/tailwindcss and svelte-add/graphql commands.
🎁 Contributing
This is a community project! Here are some ways you can help:
- Battle test (combinations of) adders to make sure they're always composable and find other edge cases, bugs, etc.
- Fix known issues and missing features in an adder per the open issues on its repository.
- Read this repository's open issues to talk about ideas for new adders.
- If you're ready to make a new adder, try using an existing adder's repository as a template and change it up to make it add the functionality you want.
- Create a pull request to add your project to this list.
Repository preview image generated with GitHub Social Preview
This README was generated with ❤️ by readme-md-generator