tiagob / create-full-stack

Set up a TypeScript full stack with one command.
https://create-full-stack.com
MIT License
97 stars 9 forks source link

Contribution guide #162

Closed gjolund closed 3 years ago

gjolund commented 3 years ago

I would love to start contributing to this project, but the code base is a little inaccessible without documentation.

Are there any resources available explaining the generator structure you chose and how we can start extending it?

tiagob commented 3 years ago

Great to hear! Totally fair. It's not documented.

A quick overview.

The entry point is here: https://github.com/tiagob/create-full-stack/blob/master/packages/create-full-stack/src/index.ts

There 4 main templates. Each is a combination of backend and auth. Namely:

You can find these along with common libraries under packages: https://github.com/tiagob/create-full-stack/tree/master/packages

I can cover the structure more over Zoom and answer any questions you have. Are you free to chat sometime? Can you email me@tiagobandeira.com?

gjolund commented 3 years ago

I don't know if I will be able to do zoom, I'm based out of bangkok and the time difference is pretty extreme.

I'll shoot you and email, but we can also just use this thread if you want.