Skip to content
This repository was archived by the owner on Apr 19, 2021. It is now read-only.

Commit 8a64fe1

Browse files
committed
📄 docs: direct to Svelte Adders
1 parent bdc5b88 commit 8a64fe1

File tree

1 file changed

+3
-32
lines changed

1 file changed

+3
-32
lines changed

README.md

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -34,38 +34,9 @@ This template comes from combining two of my smaller ones: [one for Tailwind CSS
3434

3535

3636
## 🧭 Project Status
37-
Sapper is going to change.
37+
**This project base will continue to be maintained** [until SvelteKit is ready](https://svelte.dev/blog/whats-the-deal-with-sveltekit).
3838

39-
Until `create-svelte` and `@sveltejs/kit` are ready, **this project base will continue to be maintained**.
40-
41-
But, once we move on, I won't be creating project bases (templates / boilerplates) anymore. Instead, you'll apply presets onto the default template like this:
42-
43-
```sh
44-
npm init svelte@next # Use the official template from create-svelte
45-
46-
npx use-preset babichjacob/svelte-add-postcss # Apply the changes to set up PostCSS for create-svelte
47-
npx use-preset babichjacob/svelte-add-tailwindcss # Apply the changes to set up Tailwind CSS for create-svelte as long as PostCSS is already set up
48-
# The above commands already work, by the way
49-
50-
# The following are hypothetical commands and the real ones might look and work differently:
51-
npx use-preset babichjacob/svelte-add-typescript # Apply the changes to set up TypeScript for create-svelte
52-
npx use-preset babichjacob/svelte-add-typegraphql # Apply the changes to set up TypeGraphQL for create-svelte as long as TypeScript is already set up
53-
54-
npx use-preset babichjacob/svelte-add-firebase-hosting # Apply the changes to set up Firebase deployment for create-svelte
55-
```
56-
57-
This should have the same result as cloning a project base, but there are more reasons to reach for this solution:
58-
1. Reduced "heartbeat commits" (like upgrading packages to their latest versions) to prove the project still works
59-
2. Allows picking parts instead of taking *all or nothing* from a project base
60-
3. Focus on higher quality "atomic" presets. For example, there might be a `svelte-add-pwa` preset that adds a service worker and `manifest.json` with example icon files like we have now
61-
4. `create-svelte` is young and probably going to change often, so only affected presets will need to be updated
62-
5. Reduced duplication: I won't need to copy over changes from one project base to another to keep them synchronized
63-
64-
Than there are to continue making project bases:
65-
1. (I suspect) preset logic is complex
66-
2. I suspect presets are harder to test and can have harder to predict errors
67-
68-
So this is what's going to happen.
39+
Once you are prepared to migrate, check out the [Svelte Adders](https://github.com/babichjacob/svelte-adders) project for information about how to recreate this project base's functionality. You should specifically look at [svelte-add-firebase-hosting](https://github.com/babichjacob/svelte-add-firebase-hosting), [svelte-add-tailwindcss](https://github.com/babichjacob/svelte-add-tailwindcss), and [svelte-add-graphql](https://github.com/babichjacob/svelte-add-graphql). Beware that svelte-add-graphql is not compatible with svelte-add-firebase-hosting yet.
6940

7041
**Read on to use this project base today:**
7142

@@ -81,7 +52,7 @@ git clone https://github.com/babichjacob/sapper-firebase-typescript-graphql-tail
8152
Click the `Use this template` button on [this project's GitHub page](https://github.com/babichjacob/sapper-firebase-typescript-graphql-tailwindcss-actions-template).
8253

8354
### ⬇️ Install Dependencies
84-
You need to be using version 12 or higher of Node; the `package.json` `engines` field only specifies `10` for Cloud Functions for Firebase.
55+
You need to be using version 14.15 or higher of Node; the `package.json` `engines` field only specifies `10` for Cloud Functions for Firebase.
8556

8657
```sh
8758
cd sapper-firebase-typescript-graphql-tailwindcss-actions-template

0 commit comments

Comments
 (0)