michael / editable-website

A SvelteKit template for building CMS-free editable websites
https://editable.website
MIT License
1.34k stars 103 forks source link

Which components/scripts are strictly necessary? #24

Open lia-07 opened 7 months ago

lia-07 commented 7 months ago

Hi, I recently discovered this project and it looks amazing. I am looking to design a website from scratch and use this project in my implementation of it. I was wondering if someone could quickly give me a "shortcut" and tell me which of the files (components and scripts) are strictly necessary for the editor and site to function, and which are safe to delete. I am already familiar with SvelteKit so I know I can delete most of the directories in src/routes/ if necessary (assuming not api and assets).

I think the technique of using an example project as documentation is unique and useful, seeing as you can see the code in-use and make changes to it, however it can make it harder to get started quickly.

michael commented 7 months ago

Hey, the answer is, it depends. :) If you don't use images for instance you could drop all the assets related parts.

I'd recommend you to start with a fresh SvelteKit project and just migrate over the code you need. This way it will stay the most minimal for your usecase and you'll learn a lot. :)

lia-07 commented 7 months ago

Yep thanks :D I was going through the code manually and figured out what I need, but I kept this issue up for future reference.

michael commented 7 months ago

It's a valid question. Let's keep the issue open, until we have a solid answer for it and include it in the README. :)

lia-07 commented 4 months ago

If you like/it would be helpful, I could start writing some preliminary docs or put together some type of init command to scaffold a barebones project? Of course nothing official, unless you approved it. Unless you wanted to keep the philosophy of having people learn for themselves, which is also fine :D