Documentation?

[msj121]

Would be useful for some direction on how to proceed with this project. As being new to qwik and vendure its a lot for me.

Example: For others: to get network access, modify package.json: so that "start" is now: vite --open --mode ssr --host 0.0.0.0 (host is added).

Now I know that not everyone needs that, but next steps via building for production would be useful, especially how to add https to the site etc.... It would be just nice to have a little more hand holding to get things up and running properly.

I appreciate the project and it looks really cool, but definitely having trouble trying to get something working for me.

For some reason I can't create an account even though afaik I have connected to my own vendure instance using the ".env" file.

I get the following at user registration: Account registration is not supported by the demo Vendure instance. In order to use it, please connect to your own local / production instance.

[gioboa]

Thanks for your report, we will work to clarify and create FAQs

[msj121]

@gioboa Thanks - I didn't mean to be rude, I'd be happy to help if you point me in some right directions.

[gioboa]

@msj121 no problem. Can you list here the questions you would like to clarify?

[msj121]

Okay, after doing a lot more reading on Qwik City specifically and cloudfare things are starting to make a lot more sense... Once I get things running I will try to contribute something to documentation, either here or somewhere else for anyone who needs some advice and is new to everything.

1). Out of curiosity, is the ecommerce store tailored for cloudfare (ie: is there something that makes the adapter for cloudfare necessary) or can express or some other adapter be used?

2). Sign up page, by default states that the application is not connected to your own vendure api (ie: Message about cannot setup user). This confused me even after changing, .env file to indeed connect, I thought it didn't work. Perhaps is there a way to make the message more universal, so it can work on demo but also a git clone. Like using the word "ignore if local" or something? Not a big deal, but would be useful.

[gioboa]

Great, you can contribute by adding few FAQs in the Readme. This cloud be valuable

1. you can deploy the application in different environment (e.g vercel, fastify, etc. etc) there isn't a specific cloudflare feature for this application

2. what do you mean with message?

[msj121]

For 2. It was just the following:

https://github.com/vendure-ecommerce/storefront-qwik-starter/blob/9099a34b8e8eb5677e435e3c369a8ce659cc82d7/src/routes/sign-up/index.tsx#L65C2-L71C12

<p>
      Account registration is not supported by the demo Vendure instance. In order to use
      it, please connect to your own local / production instance.
</p>

This misled me into thinking my storefront was connecting to the demo vendure, when after changing .env it was actually connected to my own. Perhaps, making this message dependent on the .env url being the demo vendure url, or perhaps just rewriting to say:

If this is still using public vendure instance, you cannot create an account. 
Please connect your own vendure instance by modifying the .env file to point to your instance.

Or something like that. Not a big deal, but it did throw me for a little bit, I should've checked the code, but I didn't realize it was a hard-coded message since it states matter of fact that I needed to create my own instance.

[gioboa]

We can log a message in the terminal and create a FAQ for that. Would you like to open a PR to add FAQs in the readme?

[gioboa]

I added the first FAQ question https://github.com/vendure-ecommerce/storefront-qwik-starter#can-i-host-the-application-in-my-environment-or-is-limited-to-cloudflare @msj121 I really would like to have your point of view because I'm biased. Pls drop a PR to add more questions

[ahnpnl]

It would be nice to have architecture things documented too. For example, I’m looking at this repo as an example of how to use graphql because I’m using a client lib like Apollo or urql.

The architecture decisions can be:

• App structure
• Library decisions
• Component design
• When to use this or that and explanation
• Best practices: SEO, api interactions. and so on :)

[gioboa]

@ahnpnl yep, sounds reasonable