add customization checklist #171
Conversation
There was a problem hiding this comment.
Nice, I like the checklist!
For me, what happened is that I got lost quite early, at the start of this doc, at the HOLD UP! caution piece. I saw the instructions to explore parts of the app, and why I did see the opensaas.sh link, I went exploring the app on my disk -> it just started running, I wanted to see what it can do. And then I hit the issues, start with signup itself where I didn't know how to verify the email.
So, I would start at the very top, try to prevent this from happening. I wouldn't send them to opensaas.sh when they have their own thing running right in front of them.
I tried to explain this in the issue here
What do you think about this, I am not making this up am I?
I am thinking, maybe we should open with something like "hey, so you have an app on your disk, great! Note that this app, while running, is missing some key configuration that allows it to fully work. It doesn't yet have API keys for Sengrid, Stripe, ... . That means that those functionalities won't work for now, till you provide those. But you can already start exploring! ... "
Also, we need to immediately let them know about the situation with the signup and email that is not sent to them: that they need to look into the terminal.
Maybe we should start the whole page as
Awesome, you have your own saas app running! But, before you dive in into it, couple of things to keep in mind:
- While working, your app is at this moment still missing some key configuration ...
- When signing up with new user, you will get a message to check your email for verification link. However, the email will never arrive, because in development emails are instead written to your terminal, in server logs. So check that out for signup verification link and similar.
- opensaas.sh is actually built with opensaas, and you can check it out to see how the fully working app works like. It is very similar to the app you are running locally, with some small tweaks.
So, go for it, give your app a spin! And in parallel, also check opensaas.sh to see what it looks like when it fully works. We suggest trying out following things:
- explore the landing page
- ...
Following is a short guide through the codebase, and at the end we also prepared a checklist of likely changes you will want to start with to make the app in front you your own. After that, only your imagination is limit!
Ok, I am not sure how exactly to do the point (3), how to do the opensaas thing, maybe that is redundant after I added that text below. But I really like this last idea I have here hah! I like the idea of "Stop, this is where you are, these are the caveats, and this is how you should proceed". And it should be at the top of the file, at the very start, later is too late.
What do you think, do you like any of these, what do you think could work?
There was a problem hiding this comment.
Nice @vincanger I think this looks great now! How do you like it? I approved it, but left some minor comments, please handle those however you like and then merge.
| - [ ] check out the blog | ||
| ::: | ||
| 1. When signing up with a new user, you will get a message to check your email for a verification link. But, in development, these emails are simply written to your terminal. **So, to continue with the registration process, check your server logs after sign up**! | ||
| 2. Your app is still missing some key configurations (e.g. Stripe, OpenAI, AWS S3, Auth, Analytics). These services won't work at the moment, but don't fear, because **we've provided detailed guides in these docs to help you set up all the services in this template**. |
There was a problem hiding this comment.
| 2. Your app is still missing some key configurations (e.g. Stripe, OpenAI, AWS S3, Auth, Analytics). These services won't work at the moment, but don't fear, because **we've provided detailed guides in these docs to help you set up all the services in this template**. | |
| 2. Your app is still missing some key configurations (e.g. Stripe, OpenAI, AWS S3, Auth, Analytics). These services won't work at the moment, but don't fear, because **we've provided detailed guides in these docs to help you set up all the services in this template**. Despite that, you can start exploring your app right now! |
Maybe this helps? Maybe it is not needed, if you think so then just resolve this comment.
| Remember, this template is built on the Wasp framework. If, at any time, these docs fail to provide enough information about a certain built-in feature, make sure to check out the [Wasp docs](https://wasp-lang.dev/docs)! | ||
| ::: | ||
|
|
||
| But before you start setting up the main features, let's walk through the customizations you will likely want to make to the template to make it your own. |
There was a problem hiding this comment.
Hey wait, so the part above whih said we will first have guides and then a chekclist was a lie :D!
There was a problem hiding this comment.
I slightly reworded the intro so that it's no longer a lie
| ::: | ||
| - [ ] Update meta tags in `app.head` (even if you don't have a custom domain yet, put one you would like to have, as this won't affect development). | ||
| - [ ] Update `app.emailSender.defaultFrom.name` with the name of your app/company/whatever you want your users to see in their inbox, if you're using the `emailSender` feature and/or `email` Auth method. | ||
| - [ ] Rename Entites and their properties, Routes/Pages, & Operations, if you wish. |
There was a problem hiding this comment.
Maybe put this one as the last bullet point in this section.
Co-authored-by: Martin Šošić <[email protected]>
Co-authored-by: Martin Šošić <[email protected]>
…en-saas into improve-guided-tour
Description
Contributor Checklist