From 140f3fc74fc9f885f089ef302198dcbc6a44b2c2 Mon Sep 17 00:00:00 2001 From: Will Beaumont <39424606+nmbeau@users.noreply.github.com> Date: Sat, 19 Aug 2023 09:50:02 -0700 Subject: [PATCH 1/4] add instructions for linting and formatting --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e93102..d7fb158 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ The group meets most Mondays 6pm PST ([meetup](https://www.meetup.com/all-things Check out our [Figma wire-frame](https://www.figma.com/file/6e3cBuEHOIpWvqT31Zd29p/Social-Plan-it?type=design&node-id=0-1&mode=design&t=DpLSfRITCDDG1pj0-0). -## Setup instructions +## Initial Setup Instructions 1. Fork the repo 2. Clone your fork @@ -20,3 +20,11 @@ Check out our [Figma wire-frame](https://www.figma.com/file/6e3cBuEHOIpWvqT31Zd2 10. Create a pull request 11. Iterate on the solution 12. Get merged + +## 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). + +## Database Seed and Refresh + +_I think this is something not currently working for me...researching how to update and will include instructions here._ From 80d13e286d0d0e57567623ca346f57e5dfb5eec4 Mon Sep 17 00:00:00 2001 From: Will Beaumont <39424606+nmbeau@users.noreply.github.com> Date: Sat, 19 Aug 2023 14:03:45 -0700 Subject: [PATCH 2/4] move general helpers from CONTRIBUTING to README, add more details about our projects and scripts --- CONTRIBUTING.md | 42 +++++++++++++------------------------ README.md | 56 +++++++++++++++++++++++++++++++++++++++---------- 2 files changed, 59 insertions(+), 39 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d7fb158..58250d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,30 +1,16 @@ # Contributing -Welcome to `social-plan-it`! These are some quick notes on how to start contributing to our open source project. A good place to start is to join our [Discord server](https://discord.gg/tTD7PvwpuX). - -The group meets most Mondays 6pm PST ([meetup](https://www.meetup.com/all-things-web-react-html-css-javascript-tutoring/)) - -Check out our [Figma wire-frame](https://www.figma.com/file/6e3cBuEHOIpWvqT31Zd29p/Social-Plan-it?type=design&node-id=0-1&mode=design&t=DpLSfRITCDDG1pj0-0). - -## Initial Setup Instructions - -1. Fork the repo -2. Clone your fork -3. Set your upstream to the project main branch to avoid merge conflicts `git remote add upstream https://github.com/social-plan-it/plan-it-social-web.git` -4. Create a branch `git checkout -b ` -5. Add your `.env` file (ask the Discord for help on details) -6. Run `npm install` -7. Make your changes -8. Add you changed files with `git add` and `git commit -m ""` -9. Push your changes to your fork with `git push` -10. Create a pull request -11. Iterate on the solution -12. Get merged - -## 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). - -## Database Seed and Refresh - -_I think this is something not currently working for me...researching how to update and will include instructions here._ +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 + 3. Clone your fork + 4. Set your upstream to the project main branch to avoid merge conflicts `git remote add upstream https://github.com/social-plan-it/plan-it-social-web.git` +2. Create a branch `git checkout -b ` +3. Add your `.env` file ([example here](./EXAMPLE.ENV) or ask the Discord for help on details) +4. Run `npm install` +5. Make your changes +6. Add you changed files with `git add` and `git commit -m ""` +7. Push your changes to your fork with `git push` +8. Create a pull request +9. Iterate on the solution +10. Get merged diff --git a/README.md b/README.md index 8ce1cc7..db27f79 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,25 @@ -# Welcome to Remix! +# Welcome to Plan-it Social -- [Remix Docs](https://remix.run/docs) +Welcome to `plan-it-social-web`! These are some quick notes on how to start contributing to our open source project. A good place to start is to join our [Discord server](https://discord.gg/tTD7PvwpuX). -## Deployment +The group meets most Mondays 6pm PST ([meetup](https://www.meetup.com/all-things-web-react-html-css-javascript-tutoring/)) -After having run the `create-remix` command and selected "Vercel" as a deployment target, you only need to [import your Git repository](https://vercel.com/new) into Vercel, and it will be deployed. +## Helpful Links -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) +- [meetup](https://www.meetup.com/all-things-web-react-html-css-javascript-tutoring/) -```sh -npm i -g vercel -vercel -``` +## What we're using -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/) +- [Typescript](https://www.typescriptlang.org/) +- [React18](https://react.dev) +- [Remix](https://remix.run/docs) +- [Vercel](https://vercel.com/) ## Development @@ -33,5 +39,33 @@ Open up [http://localhost:3000](http://localhost:3000) and you should be ready t If you're used to using the `vercel dev` command provided by [Vercel CLI](https://vercel.com/cli) instead, you can also use that, but it's not needed. - 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). + +## Prisma + +We've created some handy scripts to help with database management with Prisma. Occasionally you might need to use these to update the database on your local machine. + +- `npm run build:db` - [generate your prisma client](https://www.prisma.io/docs/concepts/components/prisma-client/working-with-prismaclient/generating-prisma-client) when starting out or when updates are made to the Prisma schema + +- `npm run update:db` - [prototype your schema](https://www.prisma.io/docs/concepts/components/prisma-migrate/db-push) to iterate on schema design locally + +- `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 + +After having run the `create-remix` command and selected "Vercel" as a deployment target, you only need to [import your Git repository](https://vercel.com/new) into Vercel, and it will be deployed. + +If you'd like to avoid using a Git repository, you can also deploy the directory by running [Vercel CLI](https://vercel.com/cli): + +```sh +npm i -g vercel +vercel +``` + +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). From 29f22c60c6ddf28f970fa0fb677505e38412dc54 Mon Sep 17 00:00:00 2001 From: Will Beaumont <39424606+nmbeau@users.noreply.github.com> Date: Sat, 19 Aug 2023 17:32:14 -0700 Subject: [PATCH 3/4] moved CONTRIBUTING info into README for simplicity, fixed spelling --- CONTRIBUTING.md | 16 ---------------- README.md | 38 ++++++++++++++++++++------------------ 2 files changed, 20 insertions(+), 34 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 58250d9..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,16 +0,0 @@ -# Contributing - -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 - 3. Clone your fork - 4. Set your upstream to the project main branch to avoid merge conflicts `git remote add upstream https://github.com/social-plan-it/plan-it-social-web.git` -2. Create a branch `git checkout -b ` -3. Add your `.env` file ([example here](./EXAMPLE.ENV) or ask the Discord for help on details) -4. Run `npm install` -5. Make your changes -6. Add you changed files with `git add` and `git commit -m ""` -7. Push your changes to your fork with `git push` -8. Create a pull request -9. Iterate on the solution -10. Get merged diff --git a/README.md b/README.md index db27f79..6f9c919 100644 --- a/README.md +++ b/README.md @@ -8,16 +8,16 @@ The group meets most Mondays 6pm PST ([meetup](https://www.meetup.com/all-things - [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/) +- [GitHub](https://github.com/social-plan-it) +- [Meetup](https://www.meetup.com/all-things-web-react-html-css-javascript-tutoring/) ## What we're using - [MySQL](https://www.mysql.com/) - [Prisma](https://www.prisma.io/) -- [tailwindcss](https://tailwindcss.com/) +- [Tailwind CSS](https://tailwindcss.com/) - [Typescript](https://www.typescriptlang.org/) -- [React18](https://react.dev) +- [React 18](https://react.dev) - [Remix](https://remix.run/docs) - [Vercel](https://vercel.com/) @@ -41,7 +41,22 @@ If you're used to using the `vercel dev` command provided by [Vercel CLI](https: Vercel -## Contributing - [look at our doc here](./CONTRIBUTING.md) +## Contributing + +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 + 3. Clone your fork + 4. Set your upstream to the project main branch to avoid merge conflicts `git remote add upstream https://github.com/social-plan-it/plan-it-social-web.git` +2. Create a branch `git checkout -b ` +3. Add your `.env` file ([example here](./EXAMPLE.ENV) or ask the Discord for help on details) +4. Run `npm install` +5. Make your changes +6. Add you changed files with `git add` and `git commit -m ""` +7. Push your changes to your fork with `git push` +8. Create a pull request +9. Iterate on the solution +10. Get merged ## Formatting and Linting @@ -56,16 +71,3 @@ We've created some handy scripts to help with database management with Prisma. O - `npm run update:db` - [prototype your schema](https://www.prisma.io/docs/concepts/components/prisma-migrate/db-push) to iterate on schema design locally - `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 - -After having run the `create-remix` command and selected "Vercel" as a deployment target, you only need to [import your Git repository](https://vercel.com/new) into Vercel, and it will be deployed. - -If you'd like to avoid using a Git repository, you can also deploy the directory by running [Vercel CLI](https://vercel.com/cli): - -```sh -npm i -g vercel -vercel -``` - -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). From 3aa0032c453a7d16200112f77ccf664755a63e53 Mon Sep 17 00:00:00 2001 From: Will Beaumont <39424606+nmbeau@users.noreply.github.com> Date: Mon, 21 Aug 2023 07:17:39 -0700 Subject: [PATCH 4/4] update alphabetical order and other tech --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6f9c919..e707f98 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,14 @@ The group meets most Mondays 6pm PST ([meetup](https://www.meetup.com/all-things ## What we're using +- [Figma](https://www.figma.com/) - [MySQL](https://www.mysql.com/) +- [PlanetScale] (https://planetscale.com/) - [Prisma](https://www.prisma.io/) -- [Tailwind CSS](https://tailwindcss.com/) -- [Typescript](https://www.typescriptlang.org/) - [React 18](https://react.dev) - [Remix](https://remix.run/docs) +- [Tailwind CSS](https://tailwindcss.com/) +- [TypeScript](https://www.typescriptlang.org/) - [Vercel](https://vercel.com/) ## Development