search

jaydenseric / ruck

Ruck is an open source buildless React web application framework for Deno.
https://ruck.tech
MIT License
149 stars 1 forks source link

quick start? #3

Closed aladdin-add closed 2 years ago

aladdin-add commented 2 years ago

Hi, I'm extremely interested in ruck, but is there a quick way to get started (without copy these code from the README)?

jaydenseric commented 2 years ago

Glad to hear that, welcome :)

If you just want to quickly have a Ruck project running on your local machine to play around with, the fastest way is to clone one of the Ruck projects listed in the readme “Examples” section, and follow the (brief, don't worry) installation instructions in the specific project readme.

If you want to actually start a real Ruck project from scratch, I recommend following the Ruck readme “Installation” instructions step by step to create the required files. This way you will understand the purpose of each file, and how Ruck works as a system. It's actually simpler than all the writing may seem at first, because each file is explained in quite a bit of depth.

Ruck has a different philosophy to some other web app frameworks; there is not supposed to be any mysterious boilerplate a quick start script sets up on your behalf or black box magic about how any of it works. It's realistic for someone who is curious to be able to read the Ruck source code and learn how everything works, although that is not necessary to make apps.

If you have any further questions feel free to keep commenting here!

aladdin-add commented 2 years ago

just cloned ruck-website, and created a ./env.sh as stated in readme, but got the following error 😂:

➜  ruck-website git:(main) ./scripts/dev.sh
Missing environment variable `ACCESS_TOKEN_GITHUB`.

I'll just try from scratch, and (maybe) make a github template later. :)

jaydenseric commented 2 years ago

You should be able to just set ACCESS_TOKEN_GITHUB="" in the scripts/.env.sh file and I think the only consequence will be loading errors if you visit routes that query GitHub data.

The simplest one to try would be the SVG symbol viewer app, as it doesn't have any dynamic routes or require env var tokens:

https://github.com/jaydenseric/svg-symbol-viewer#installation

The other side of the coin of the example being simple, is that you won't learn as much about how to do realistic things like query external APIs.

aladdin-add commented 2 years ago

I've finally made an app starter: https://github.com/weiran-zsd/ruck-starter. 🎉

just a few feedback: