Update README.md and CONTRIBUTING.md to add linting/formatting and prisma help #57

willbeaumont · 2023-08-19T16:53:44Z

Issue: #1, #11

Summary (1-2 sentences)

Adding references to our documentation on setting up linting and formatting. Also added some information about our prisma scripts. Please feel free to update/comment as desired. Hoping to save some time looking through discord to find info 😉

Details (reason and description of the changes)

CONTRIBUTING.md
- Moved general info (meetup, discord, etc) about our project to README
- Updated instructions to mention differences for those who are contributors in our repo
README.md - please add any links/list items I missed!
- Updated top to talk about our project some
- Added Helpful links - links to project resources
- Added What we're using - list of the tech we're using
- Linked to Contributing
- Added Formatting and Linting - quick ref to our script and link to Andre's doc
- Added Prisma - talked about the different db scripts. Check these for lies please 🫠

Sources (links that helped to resolve these challenges.)

Why is --require tsconfig-paths/register was added to the seed script? It's so you can import things using the ~ feature common to most Remix app setups. (link)

vercel · 2023-08-19T16:53:48Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
plan-it-social-web	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 21, 2023 2:18pm

…out our projects and scripts

andrelandgraf

Thanks for doing this! :) Left some NIT comments.

andrelandgraf · 2023-08-20T00:13:24Z

README.md

+- [Prisma](https://www.prisma.io/)
+- [tailwindcss](https://tailwindcss.com/)
+- [Typescript](https://www.typescriptlang.org/)
+- [React18](https://react.dev)


NIT:

Suggested change

- [React18](https://react.dev)

- [React 18](https://react.dev)

andrelandgraf · 2023-08-20T00:13:36Z

README.md

-It is generally recommended to use a Git repository, because future commits will then automatically be deployed by Vercel, through its [Git Integration](https://vercel.com/docs/concepts/git).
+- [MySQL](https://www.mysql.com/)
+- [Prisma](https://www.prisma.io/)
+- [tailwindcss](https://tailwindcss.com/)


NIT:

Suggested change

- [tailwindcss](https://tailwindcss.com/)

- [Tailwind CSS](https://tailwindcss.com/)

andrelandgraf · 2023-08-20T00:13:50Z

README.md

+- [Discord server](https://discord.gg/tTD7PvwpuX)
+- [Figma wire-frame](https://www.figma.com/file/6e3cBuEHOIpWvqT31Zd29p/Social-Plan-it?type=design&node-id=0-1&mode=design&t=DpLSfRITCDDG1pj0-0)
+- [github repo](https://github.com/social-plan-it/plan-it-social-web)
+- [meetup](https://www.meetup.com/all-things-web-react-html-css-javascript-tutoring/)


NIT:

Suggested change

- [meetup](https://www.meetup.com/all-things-web-react-html-css-javascript-tutoring/)

- [Meetup](https://www.meetup.com/all-things-web-react-html-css-javascript-tutoring/)

andrelandgraf · 2023-08-20T00:14:22Z

README.md

-If you'd like to avoid using a Git repository, you can also deploy the directory by running [Vercel CLI](https://vercel.com/cli):
+- [Discord server](https://discord.gg/tTD7PvwpuX)
+- [Figma wire-frame](https://www.figma.com/file/6e3cBuEHOIpWvqT31Zd29p/Social-Plan-it?type=design&node-id=0-1&mode=design&t=DpLSfRITCDDG1pj0-0)
+- [github repo](https://github.com/social-plan-it/plan-it-social-web)


Suggested change

- [github repo](https://github.com/social-plan-it/plan-it-social-web)

- [GitHub](https://github.com/social-plan-it)

andrelandgraf · 2023-08-20T00:15:18Z

README.md

 <img align="center" src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSagMR3FC2rPHvoqZFjHunC5DkmFLdeNzok9d7P8OHW&s" width="50%" alt="Vercel" >
+
+## Contributing - [look at our doc here](./CONTRIBUTING.md)


Should we move this section into the CONTRIBUTING.md file? What do you think?

Yeah for sure, was trying to think of a way to direct people from the readme to the contributing markup. Not entirely sure if you have to tell people where to go or if they just know.

I would recommend we bundle all "Contribution" information in one place, so it's easier to find. This could be a section in the README or a standalone CONTRIBUTION document. If we have a separate document, I would refer to it in the README! :)

Ok! I prefer less files. Happy to put back in if the group misses CONTRIBUTING.md

andrelandgraf · 2023-08-20T00:15:43Z

README.md

+
+## Formatting and Linting
+
+Please utilize our formatting and linting command `npm run lint`. Also included in our documentation, are great instructions on how to [setup this functionality to automatically run on save in VS code](./docs/formatting-and-linting.md).


Great! We will expand on this on Monday!

andrelandgraf · 2023-08-20T00:16:25Z

README.md

+
+- `npm run seed:db` - [consistently create data by seeding](https://www.prisma.io/docs/guides/migrate/seed-database) data into our database. We have a slightly different setup than when is in the Prisma docs. We are using `--require tsconfig-paths/register` to use the `~` path feature in Remix ([ref: Kent C. Dodds](https://github.com/remix-run/blues-stack/issues/143#issuecomment-1515339235))
+
+## Deployment


I think this section can be removed. It describes how to deploy a new Remix project.

Thanks for sharing this explanation from Kent. That's good to know.

willbeaumont · 2023-08-20T00:34:06Z

Thank you Andre for the comments, I've committed your suggestions!

shami-dev · 2023-08-20T10:30:12Z

README.md

+- [Prisma](https://www.prisma.io/)
+- [Tailwind CSS](https://tailwindcss.com/)
+- [Typescript](https://www.typescriptlang.org/)
+- [React 18](https://react.dev)


NIT: Just "React" without pointing the verion.

I'd like to leave 18, it's a signal to any reviewing our project we're keeping up with the latest and greatest of React. Might be a moot point with our use of Remix.

shami-dev · 2023-08-20T10:31:39Z

README.md

+- [Typescript](https://www.typescriptlang.org/)
+- [React 18](https://react.dev)
+- [Remix](https://remix.run/docs)
+- [Vercel](https://vercel.com/)



NIT: You might write all techs in alphabetical order to increase readability.

shami-dev · 2023-08-20T10:35:20Z

README.md

+- [Typescript](https://www.typescriptlang.org/)
+- [React 18](https://react.dev)
+- [Remix](https://remix.run/docs)
+- [Vercel](https://vercel.com/)



Let's add:

[PlanetScale] (https://planetscale.com/)

shami-dev · 2023-08-20T10:35:44Z

README.md

+- [MySQL](https://www.mysql.com/)
+- [Prisma](https://www.prisma.io/)
+- [Tailwind CSS](https://tailwindcss.com/)
+- [Typescript](https://www.typescriptlang.org/)


NIT: TypeScript

shami-dev · 2023-08-20T10:38:11Z

README.md

+- [Typescript](https://www.typescriptlang.org/)
+- [React 18](https://react.dev)
+- [Remix](https://remix.run/docs)
+- [Vercel](https://vercel.com/)



Not sure, maybe also:

[Figma] (https://www.figma.com/)

shami-dev · 2023-08-20T10:42:25Z

README.md

+
+1. If you're a contributor to the repo skip to `Step 2`
+   1. Join the group, check out the [Discord server](https://discord.gg/tTD7PvwpuX)!
+   2. Fork the repo


Probably we could recommend sharing a user's GitHub profile with Andre so that he can add them to the project.

I'd prefer leave this as a conversation for people to have when they join the discord. Maybe someone new takes that responsibility up in the future.

shami-dev · 2023-08-20T10:46:33Z

README.md


-## Deployment
+The group meets most Mondays 6pm PST ([meetup](https://www.meetup.com/all-things-web-react-html-css-javascript-tutoring/))


Can I leave jokes here? Sorry in advance)
And on most Saturdays at 9 am 😄

shami-dev · 2023-08-20T10:48:55Z

README.md


-If you'd like to avoid using a Git repository, you can also deploy the directory by running [Vercel CLI](https://vercel.com/cli):
+- [Discord server](https://discord.gg/tTD7PvwpuX)
+- [Figma wire-frame](https://www.figma.com/file/6e3cBuEHOIpWvqT31Zd29p/Social-Plan-it?type=design&node-id=0-1&mode=design&t=DpLSfRITCDDG1pj0-0)


Perhaps we should say that the request will be approved by @CamilingJS.

shami-dev

Thanks for making the project clearer for new contributors! Left some general and nitpicking comments.

willbeaumont · 2023-08-21T14:21:30Z

Thank you for the comments and edits! I feel it's in a good place to merge. Let's get it out there and update as needed in the future.

shami-dev

Looks nice!

add instructions for linting and formatting

140f3fc

willbeaumont changed the title ~~[WIP] Update CONTRIBUTING.md to add linting/formatting and prisma help~~ [WIP] Update README.md and CONTRIBUTING.md to add linting/formatting and prisma help Aug 19, 2023

move general helpers from CONTRIBUTING to README, add more details ab…

80d13e2

…out our projects and scripts

vercel bot deployed to Preview – plan-it-social-web August 19, 2023 21:04 View deployment

willbeaumont changed the title ~~[WIP] Update README.md and CONTRIBUTING.md to add linting/formatting and prisma help~~ Update README.md and CONTRIBUTING.md to add linting/formatting and prisma help Aug 19, 2023

willbeaumont requested review from CamilingJS, andrelandgraf, eiffelwong1, thisistonydang, JacobBaqleh1 and shami-dev August 19, 2023 21:17

willbeaumont self-assigned this Aug 19, 2023

andrelandgraf reviewed Aug 20, 2023

View reviewed changes

moved CONTRIBUTING info into README for simplicity, fixed spelling

29f22c6

vercel bot deployed to Preview – plan-it-social-web August 20, 2023 00:32 View deployment

shami-dev reviewed Aug 20, 2023

View reviewed changes

update alphabetical order and other tech

3aa0032

vercel bot deployed to Preview – plan-it-social-web August 21, 2023 14:18 View deployment

willbeaumont requested a review from shami-dev August 21, 2023 14:21

shami-dev approved these changes Aug 21, 2023

View reviewed changes

andrelandgraf approved these changes Aug 22, 2023

View reviewed changes

willbeaumont merged commit dda56d3 into main Aug 22, 2023
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update README.md and CONTRIBUTING.md to add linting/formatting and prisma help #57

Update README.md and CONTRIBUTING.md to add linting/formatting and prisma help #57

willbeaumont commented Aug 19, 2023 •

edited

Loading

vercel bot commented Aug 19, 2023 •

edited

Loading

andrelandgraf left a comment

andrelandgraf Aug 20, 2023

andrelandgraf Aug 20, 2023

andrelandgraf Aug 20, 2023

andrelandgraf Aug 20, 2023

andrelandgraf Aug 20, 2023

willbeaumont Aug 20, 2023

andrelandgraf Aug 20, 2023

willbeaumont Aug 20, 2023

andrelandgraf Aug 20, 2023

andrelandgraf Aug 20, 2023

shami-dev Aug 20, 2023

willbeaumont commented Aug 20, 2023

shami-dev Aug 20, 2023

willbeaumont Aug 21, 2023

shami-dev Aug 20, 2023

shami-dev Aug 20, 2023

shami-dev Aug 20, 2023

shami-dev Aug 20, 2023

shami-dev Aug 20, 2023

willbeaumont Aug 21, 2023

shami-dev Aug 20, 2023

shami-dev Aug 20, 2023

shami-dev left a comment

willbeaumont commented Aug 21, 2023

shami-dev left a comment

	- [React18](https://react.dev)
	- [React 18](https://react.dev)

	- [tailwindcss](https://tailwindcss.com/)
	- [Tailwind CSS](https://tailwindcss.com/)

	- [meetup](https://www.meetup.com/all-things-web-react-html-css-javascript-tutoring/)
	- [Meetup](https://www.meetup.com/all-things-web-react-html-css-javascript-tutoring/)

	- [github repo](https://github.com/social-plan-it/plan-it-social-web)
	- [GitHub](https://github.com/social-plan-it)

		<img align="center" src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSagMR3FC2rPHvoqZFjHunC5DkmFLdeNzok9d7P8OHW&s" width="50%" alt="Vercel" >

		## Contributing - [look at our doc here](./CONTRIBUTING.md)


		## Formatting and Linting

		Please utilize our formatting and linting command `npm run lint`. Also included in our documentation, are great instructions on how to [setup this functionality to automatically run on save in VS code](./docs/formatting-and-linting.md).


		- `npm run seed:db` - [consistently create data by seeding](https://www.prisma.io/docs/guides/migrate/seed-database) data into our database. We have a slightly different setup than when is in the Prisma docs. We are using `--require tsconfig-paths/register` to use the `~` path feature in Remix ([ref: Kent C. Dodds](https://github.com/remix-run/blues-stack/issues/143#issuecomment-1515339235))

		## Deployment


		## Deployment
		The group meets most Mondays 6pm PST ([meetup](https://www.meetup.com/all-things-web-react-html-css-javascript-tutoring/))

Update README.md and CONTRIBUTING.md to add linting/formatting and prisma help #57

Update README.md and CONTRIBUTING.md to add linting/formatting and prisma help #57

Conversation

willbeaumont commented Aug 19, 2023 • edited Loading

Summary (1-2 sentences)

Details (reason and description of the changes)

Sources (links that helped to resolve these challenges.)

vercel bot commented Aug 19, 2023 • edited Loading

andrelandgraf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willbeaumont commented Aug 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shami-dev left a comment

Choose a reason for hiding this comment

willbeaumont commented Aug 21, 2023

shami-dev left a comment

Choose a reason for hiding this comment

willbeaumont commented Aug 19, 2023 •

edited

Loading

vercel bot commented Aug 19, 2023 •

edited

Loading