chore (#19): updates project readme #33

tzmanics · 2022-03-23T05:10:34Z

closes #19

netlify · 2022-03-23T05:10:40Z

✅ Deploy Preview for kpop-stack ready!

Name	Link
🔨 Latest commit	`dbdaef2`
🔍 Latest deploy log	https://app.netlify.com/sites/kpop-stack/deploys/624dcf4c99d90d000915ff51
😎 Deploy Preview	https://deploy-preview-33--kpop-stack.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

tzmanics · 2022-04-05T21:30:54Z

@bencodezen & @maxcell: let me know what you think of the updates to the dev section and how we're listing the env vars now. also, should I add DATABASE_URL and SESSION_SECRET to the .env.sample file.

@maxcell I couldn't figure out where to find SESSION_SECRET, could you let me know when you get a chance? ty!

maxcell · 2022-04-05T21:40:05Z

@tzmanics: Yeah you don't need to add DATABASE_URL but we do need SESSION_SECRET (though that should be in the main branch already). This should be something that the user sets.

If they use the remix template flow npx create-remix --template remix-run/kpop-stack this should be done for them that's part of what the remix.init/index.js does in these lines.

If we wanted to use our secret, we would need to export it from Netlify. If you wanted to set your own, you could make it any string in a .env file. But the session secret can be whatever value we want it to be.

maxcell

I have just a few notes. I don't think anything is actually a blocker in terms of we need to uproot so I think the biggest thing (which really is just like dust) might be us deciding on if it is important to us to have them set the SESSION_SECRET in our .env

maxcell · 2022-04-06T13:13:03Z

README.md

+  <details>
+  <summary>Environment Variable list in project dashboard.</summary>
+
+  ![screenshot of env vars in Netlify UI](https://res.cloudinary.com/dzkoxrsdj/image/upload/v1649190710/Screen_Shot_2022-04-05_at_4.31.09_PM_m4rmer.jpg)
+
+  </details>


Thank you for bringing this up earlier, I think having a screenshot like this is valuable! I would probably say that updating it without the DATABASE_URL to avoid the confusion

maxcell · 2022-04-06T13:14:57Z

README.md

+- Add your Supabase environment variables to a `.env` file like [`.env.sample`](./.env.sample) file or through the Netlify project dashboard at [https://app.netlify.com/](https://app.netlify.com/) Site settings/Build & deploy/Environment:
+
+  ```
+  SUPABASE_URL=""
+  SUPABASE_ANON_KEY=""
+  ```


Similarly we probably want to share that they need to create their SESSION_SECRET as well, I have no good strategy for that though outside of the remix workflow. 😅 I don't mind pointing them to something like this password generator tool from 1Password https://1password.com/password-generator/

maxcell · 2022-04-06T13:22:54Z

README.md

+
+### Relevant code:
+
+This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Architect and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes.


Suggested change

This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Architect and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes.

This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Supabase and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes.

maxcell · 2022-04-06T13:27:25Z

README.md

+netlify init # initialize a new Netlify project & deploy
+```
+
+One the CLI is installed you can also create a site using the `sites:create-template` command:


Suggested change

One the CLI is installed you can also create a site using the `sites:create-template` command:

Or with the CLI is installed, you can also create a site using the `sites:create-template` command:

maxcell · 2022-04-06T13:29:31Z

README.md

+
+Using the 'Deploy to Netlify' button or the `init` process will also set up continuous deployment for your project so that a new build will be triggered & deployed when you push code to the repo (you can change this from your project dashboard: Site Settings/Build & deploy/Continuous Deployment).
+
+You can also use `netlify deploy (--prod)` to manually deploy and `netlify open` to open your project dashboard.


I think separating these might help tell the story a bit more! I think if I hadn't seen Netlify's CLI I might assume I am to put the parenthesis around the flag.

Suggested change

You can also use `netlify deploy (--prod)` to manually deploy and `netlify open` to open your project dashboard.

You can also use `netlify deploy` or `netlify deploy --prod` to manually deploy and `netlify open` to open your project dashboard.

kentcdodds · 2022-04-06T18:08:31Z

README.md

-```sh
-npm i -g netlify-cli
+```
+npx create-remix --template remix-run/kpop-stack


Suggested change

npx create-remix --template remix-run/kpop-stack

npx create-remix --template netlify-templates/kpop-stack

kentcdodds

This is great!

Would be good to put some mention of the steps you need to complete in the log of the remix.init script so people know they can't just run the build/dev but they need to set some environment variables and things first.

Looking great though!

tzmanics added the documentation Improvements or additions to documentation label Mar 23, 2022

tzmanics self-assigned this Mar 23, 2022

bencodezen approved these changes Mar 23, 2022

View reviewed changes

tzmanics force-pushed the tzm/19/createReadme branch 2 times, most recently from 89e50d0 to f9c297d Compare April 2, 2022 02:42

tzmanics marked this pull request as ready for review April 4, 2022 17:07

maxcell reviewed Apr 6, 2022

View reviewed changes

tzmanics added 7 commits April 6, 2022 13:20

adds stack start and development sec

31c23ec

updates dev and deploy sections

6f578da

removes unused, adds image & adds testing changes

07bbb21

adds supbase project and query info

4da57d4

adds more db and dev details

2ce96e3

adds fixes and type check section

2b5596e

adds @maxcell brilliant edits

dbdaef2

tzmanics force-pushed the tzm/19/createReadme branch from de9027b to dbdaef2 Compare April 6, 2022 17:35

kentcdodds mentioned this pull request Apr 6, 2022

Create a README following the example of other stacks #19

Closed

5 tasks

kentcdodds reviewed Apr 6, 2022

View reviewed changes

tzmanics merged commit f07f01e into main Apr 6, 2022

tzmanics deleted the tzm/19/createReadme branch April 6, 2022 20:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore (#19): updates project readme #33

chore (#19): updates project readme #33

tzmanics commented Mar 23, 2022

netlify bot commented Mar 23, 2022 •

edited

Loading

tzmanics commented Apr 5, 2022

maxcell commented Apr 5, 2022 •

edited

Loading

maxcell left a comment

maxcell Apr 6, 2022

maxcell Apr 6, 2022

maxcell Apr 6, 2022

maxcell Apr 6, 2022

maxcell Apr 6, 2022

kentcdodds Apr 6, 2022

kentcdodds left a comment


		### Relevant code:

		This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Architect and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes.

	One the CLI is installed you can also create a site using the `sites:create-template` command:
	Or with the CLI is installed, you can also create a site using the `sites:create-template` command:


		Using the 'Deploy to Netlify' button or the `init` process will also set up continuous deployment for your project so that a new build will be triggered & deployed when you push code to the repo (you can change this from your project dashboard: Site Settings/Build & deploy/Continuous Deployment).

		You can also use `netlify deploy (--prod)` to manually deploy and `netlify open` to open your project dashboard.

	You can also use `netlify deploy (--prod)` to manually deploy and `netlify open` to open your project dashboard.
	You can also use `netlify deploy` or `netlify deploy --prod` to manually deploy and `netlify open` to open your project dashboard.

	npx create-remix --template remix-run/kpop-stack
	npx create-remix --template netlify-templates/kpop-stack

chore (#19): updates project readme #33

chore (#19): updates project readme #33

Conversation

tzmanics commented Mar 23, 2022

netlify bot commented Mar 23, 2022 • edited Loading

✅ Deploy Preview for kpop-stack ready!

tzmanics commented Apr 5, 2022

maxcell commented Apr 5, 2022 • edited Loading

maxcell left a comment

Choose a reason for hiding this comment

maxcell Apr 6, 2022

Choose a reason for hiding this comment

maxcell Apr 6, 2022

Choose a reason for hiding this comment

maxcell Apr 6, 2022

Choose a reason for hiding this comment

maxcell Apr 6, 2022

Choose a reason for hiding this comment

maxcell Apr 6, 2022

Choose a reason for hiding this comment

kentcdodds Apr 6, 2022

Choose a reason for hiding this comment

kentcdodds left a comment

Choose a reason for hiding this comment

netlify bot commented Mar 23, 2022 •

edited

Loading

maxcell commented Apr 5, 2022 •

edited

Loading