From 5f905a17454b46a30fadfae3b19041e446c5969c Mon Sep 17 00:00:00 2001 From: Komal Kaur Date: Wed, 25 Oct 2023 15:03:13 -0700 Subject: [PATCH 1/9] Organized set up instructions --- README.md | 66 +++-------------------------- docs/GITHUB-CODESPACES-SET-UP.md | 66 +++++++++++++++++++++++++++++ docs/LOCAL-DOCKER-SET-UP.md | 73 ++++++++++++++++++++++++++++++++ docs/gitpod-set-up.md | 58 +++++++++++++++++++++++++ 4 files changed, 203 insertions(+), 60 deletions(-) create mode 100644 docs/GITHUB-CODESPACES-SET-UP.md create mode 100644 docs/LOCAL-DOCKER-SET-UP.md create mode 100644 docs/gitpod-set-up.md diff --git a/README.md b/README.md index b5f716546..533199527 100644 --- a/README.md +++ b/README.md @@ -15,31 +15,17 @@ For a while now teachers have been asking for a way to get a birds eye view of m ## Contributing -### Optional - GitHub Codespaces Environment +This project supports multiple ways to set up the project. You can use Gitpod, Github Codespaces or locally using Docker. Please use whichever you feel the most comfortable with. We recommend Github Codespaces if you are not sure. -If you have used GitHub Codespaces in other projects, doing the same in freeCodeCamp Classroom should be straightforward. +Please read our contibution [guidelines](https://contribute.freecodecamp.org/#/how-to-contribute-to-the-codebase?id=contributing-to-the-codebase) before making your first pull request. -- https://docs.github.com/en/codespaces/overview +### Instructions to set up your code: -- https://docs.github.com/en/codespaces/getting-started +#### Option 1 - [GitHub Codespaces Environment](docs/GITHUB-CODESPACES-SET-UP.md) -- If you want a ready-made dev environment in your browser, make a fork of this repository. +#### Option 2 - [GitPod Dev Environment](docs/GITPOD-SET-UP.md) -- Afterward, set up your NextAuth-related environment variables in the `.env` file. - -- Please follow the "Setup Instructions" in the terminal for more information. - -Within freeCodeCamp Classroom, GitHub Codespaces is on par with Gitpod so that you can use either. - -### Optional - GitPod Dev Environment - -If you want a ready-made dev environment in your browser, make a fork of this repository and then prefix your fork with "gitpod.io/#". For example, - -`gitpod.io/#https://github.com/{your-github-user-name}/classroom` - -You will still need to setup your NextAuth-related environment variables in the .env file. -For more information, please follow the "Setup Instructions" in the terminal. -For setting up locally, follow the instructions below. +#### Option 3 - [Local Docker Enviornment](docs/LOCAL-DOCKER-SET-UP.md) ### Styling a component @@ -53,46 +39,6 @@ We are strongly opinionated about adding new variables/tokens to the colors. Aft We recommend going through our [system design diagram](https://www.canva.com/design/DAFo8ezu7W8/EfUE0hjSDuJHFRGnG9NOvQ/edit?utm_content=DAFo8ezu7W8&utm_campaign=designshare&utm_medium=link2&utm_source=sharebutton). -### Prepare the database - -This project uses a [PostgreSQL](https://www.postgresql.org/) database. You should follow the instructions in the linked documentation to set it up for your system. Alternatively, you can use the below commands for a docker-based setup on likes of Linux or macOS, if you have docker installed. - -
- -Docker based setup on Linux, macOS, etc. - -```console -# create a directory for the data -mkdir -p $HOME/docker/volumes/postgres - -# start a container (this will use the "latest" tag. Use the version as needed) -docker run -it --name pgsql-classroom -e POSTGRES_PASSWORD=password -d --restart unless-stopped -p 5432:5432 -v $HOME/docker/volumes/postgres:/var/lib/postgresql/data postgres:latest - -# change DATABASE_URL in your .env to -postgresql://postgres:password@localhost:5432/classroom -``` - -
- -### Get the code - -1. Clone the project repository. - ```console - git clone https://github.com/freeCodeCamp/classroom.git - cd classroom - ``` -2. We use npm (specifically npm workspaces) to manage our dependencies. - ```console - npm ci - ``` -3. Create `.env` file based on the `.env.sample` file. Theses are the environment variables that are used by the application. -4. Run `npx prisma generate`. -5. Run `npx prisma db push`. -6. Run `npx prisma db seed`. -7. Run `npm run develop`. -8. Run `npm run mock-fcc-data` -9. Run `npx prisma studio` - Need more help? Ran into issues? Check out this [guide](https://docs.google.com/document/d/1apfjzfIwDAfg6QQf2KD1E1aeD-KU7DEllwnH9Levq4A/edit) that walks you through all the steps of setting up the repository locally, without Docker. ### Join us in our [Discord Chat](https://discord.gg/qcynkd4Edx) here. diff --git a/docs/GITHUB-CODESPACES-SET-UP.md b/docs/GITHUB-CODESPACES-SET-UP.md new file mode 100644 index 000000000..98cdb6ec2 --- /dev/null +++ b/docs/GITHUB-CODESPACES-SET-UP.md @@ -0,0 +1,66 @@ +# Github Codespaces Setup Instructions + +If you have used GitHub Codespaces in other projects, doing the same in freeCodeCamp Classroom should be straightforward. We recommend reading the following if you are unfamiliar with Github Codespaces. + +- [Github Codespaces Overview](https://docs.github.com/en/codespaces/overview) +- [How to get started with Github Codespaces](https://docs.github.com/en/codespaces/getting-started) + +## Step 1: Enable Github Codespace + +- On our [github](https://github.com/freeCodeCamp/classroom), look for a green button called Code on the top right. +- Click on the button to reveal the dropdown +- Observe that there are two options, Local and Codespaces which you can switch through +- Get to the Codespaces option +- Click on Open CodeSpace. Github will take care of making the codespace for you. Don't worry if it's taking a while, it can take up to 10 mins. + +## Step 2: Set up a NextAuth Provider App + +You need to set up a NextAuth Provider and run the app. + +For dev environments, we have enabled use of the Github Provider. Please read and follow their [guide](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) to set up the oauth app. + +## Step 3: Update the .env file + +You will need to update the .env file inside Github Codespaces with the following: + +- Set DataBase Url to: + `postgresql://postgres:password@localhost:5432/classroom` + +- Set mock user data URL to: + `https://${CODESPACE_NAME}-3001.preview.app.github.dev/data` + +- Set homepage url to: + `https://${CODESPACE_NAME}-3000.preview.app.github.dev` + +- Set callback url to: + `https://${CODESPACE_NAME}-3000.preview.app.github.dev/api/auth/callback/github` + +- Set NEXTAUTH_URL to: + `https://${CODESPACE_NAME}-3000.preview.app.github.dev` + +- Set GITHUB_ID to: + - Your Client ID is shown in the OAuth app page (generated at step 2). Copy and paste to GITHUB_ID. +- Set GITHUB_SECRET to: + - Generate a **new** Client Secret. Then copy and paste to GITHUB_SECRET. + +Please follow the "Setup Instructions" in the terminal for more information. + +Within freeCodeCamp Classroom, GitHub Codespaces is on par with Gitpod so that you can use either. + +## Additional Steps to take after finishing Github Codespaces setup: + +1.Run: `npm run develop` + +2.Check to see if the website is functional and you can sign in and authorize yourself using your GitHub profile. + +3.After successfully signing in, sign out and open a new terminal. + +4.Run: `npx prisma studio` + +5.In Prisma Studio, go to User. Under the “roles” column, enter TEACHER or ADMIN. And click on the “Save Changes” button. + +6.Run `npm run mock-fcc-data` + +7.Go to the ports tab and set the visibility to public for the 3000 and 3001 ports. + +Happy coding! diff --git a/docs/LOCAL-DOCKER-SET-UP.md b/docs/LOCAL-DOCKER-SET-UP.md new file mode 100644 index 000000000..979ed3d96 --- /dev/null +++ b/docs/LOCAL-DOCKER-SET-UP.md @@ -0,0 +1,73 @@ +# Local Docker Setup Instructions + +Docker based setup **requires** Linux, macOS, etc. If you have not used docker before, we recommend reading Docker documentation to familiarize yourself. + +- [Getting Started with Docker](https://docs.docker.com/get-started/) + +## Step 1: Make sure you have Docker installed + +You will need to have Docker on your local machine to create the enviornment. Please refer to the docs to [install docker](https://docs.docker.com/get-docker/) if you do not have it already. + +## Step 2: Prepare the database + +This project uses a [PostgreSQL](https://www.postgresql.org/) database. You can use the below commands for a docker-based setup on likes of Linux or macOS. + +### Set up Docker + +```console +# create a directory for the data +mkdir -p $HOME/docker/volumes/postgres + +# start a container (this will use the "latest" tag. Use the version as needed) +docker run -it --name pgsql-classroom -e POSTGRES_PASSWORD=password -d --restart unless-stopped -p 5432:5432 -v $HOME/docker/volumes/postgres:/var/lib/postgresql/data postgres:latest + +# change DATABASE_URL in your .env to +postgresql://postgres:password@localhost:5432/classroom +``` + +## Step 3: Get the code + +1. Clone the project repository. + ```console + git clone https://github.com/freeCodeCamp/classroom.git + cd classroom + ``` +2. We use npm (specifically npm workspaces) to manage our dependencies. + ```console + npm ci + ``` +3. Create `.env` file based on the `.env.sample` file. Theses are the environment variables that are used by the application. + +## Step 4: Set up a NextAuth Provider App + +You need to set up a NextAuth Provider and run the app. + +For dev environments, we have enabled use of the Github Provider. Please read and follow their [guide](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) to set up the oauth app. + +## Step 5: Update .env file + +You will need to update the .env file inside your project with the following: + +- Set DataBase Url to: + `postgresql://postgres:password@localhost:5432/classroom` +- Set mock user data URL to: + `http://localhost:3001/data` + +- Set NEXTAUTH_URL to: + `http://localhost:3000` + +- Set GITHUB_ID to: + - Your Client ID is shown in the OAuth app page (generated at step 4). Copy and paste to GITHUB_ID. +- Set GITHUB_SECRET to: + - Generate a **new** Client Secret. Then copy and paste to GITHUB_SECRET. + +## Additional Steps to take after finishing Local Docker Setup: + +5. Run `npx prisma generate`. +6. Run `npx prisma db push`. +7. Run `npx prisma db seed`. +8. Run `npm run develop`. +9. Run `npm run mock-fcc-data` +10. Run `npx prisma studio` + +Happy Coding! diff --git a/docs/gitpod-set-up.md b/docs/gitpod-set-up.md new file mode 100644 index 000000000..caf1387f1 --- /dev/null +++ b/docs/gitpod-set-up.md @@ -0,0 +1,58 @@ +# Gitpod Setup Instructions + +Please review Gitpod docs if you are not familiar with it. + +- [How to get started with Gitpod Codespaces](https://www.gitpod.io/docs/introduction/getting-started) + +## Step 1: Enable Gitpod + +If you want a ready-made dev environment in your browser, make a fork of this repository and then prefix your fork with "gitpod.io/#". For example, + +`gitpod.io/#https://github.com/{your-github-user-name}/classroom` + +## Step 2: Set up a NextAuth Provider App + +You need to set up a NextAuth Provider and run the app. + +For dev environments, we have enabled use of the Github Provider. Please read and follow their [guide](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) to set up the oauth app. + +## Step 3: Update the .env file + +You will need to update the .env file inside Github Codespaces with the following: + +- Set DataBase Url to: + `postgresql://postgres:password@localhost:5432/classroom` + +- Set mock user data URL to: + `https://3001-${GITPOD_WORKSPACE_URL:8}/data` + +- Set homepage url to: + `https://3000-${GITPOD_WORKSPACE_URL:8}` + +- Set callback url to: `https://3000-${GITPOD_WORKSPACE_URL:8}/api/auth/callback/github` + +- Set NEXTAUTH_URL to: + `https://3000-${GITPOD_WORKSPACE_URL:8}` + +- Set GITHUB_ID to: + - Your Client ID is shown in the OAuth app page (generated at step 2). Copy and paste to GITHUB_ID. +- Set GITHUB_SECRET to: + - Generate a **new** Client Secret. Then copy and paste to GITHUB_SECRET. + +Please follow the "Setup Instructions" in the terminal for more information. + +Within freeCodeCamp Classroom, Gitpod is on par with Github Codespaces so that you can use either. + +## Additional Steps to take after finishing Gitpod Setup: + +1.Run `npm run develop` + +2.Check to see if the website is functional and you can sign in and authorize yourself using your GitHub profile. + +3.After successfully signing in, sign out and open a new terminal. + +4.Run `npx prisma studio` + +5.In Prisma Studio, go to User. Under the “roles” column, enter TEACHER or ADMIN. And click on the “Save Changes” button. + +Happy coding! From b39bc49a9bfead6a23110a3e541c3571b2b184f9 Mon Sep 17 00:00:00 2001 From: Komal Kaur Date: Wed, 25 Oct 2023 16:25:47 -0700 Subject: [PATCH 2/9] added APIs and fixed bug --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 533199527..7a1f2c4bb 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ Please read our contibution [guidelines](https://contribute.freecodecamp.org/#/h #### Option 3 - [Local Docker Enviornment](docs/LOCAL-DOCKER-SET-UP.md) +Need more help? Ran into issues? Check out this [guide](https://docs.google.com/document/d/1apfjzfIwDAfg6QQf2KD1E1aeD-KU7DEllwnH9Levq4A/edit) that walks you through all the steps of setting up the repository locally, without Docker. + ### Styling a component We recommend styling components using our [design style guide](https://design-style-guide.freecodecamp.org/). @@ -39,23 +41,31 @@ We are strongly opinionated about adding new variables/tokens to the colors. Aft We recommend going through our [system design diagram](https://www.canva.com/design/DAFo8ezu7W8/EfUE0hjSDuJHFRGnG9NOvQ/edit?utm_content=DAFo8ezu7W8&utm_campaign=designshare&utm_medium=link2&utm_source=sharebutton). -Need more help? Ran into issues? Check out this [guide](https://docs.google.com/document/d/1apfjzfIwDAfg6QQf2KD1E1aeD-KU7DEllwnH9Levq4A/edit) that walks you through all the steps of setting up the repository locally, without Docker. +## Resources -### Join us in our [Discord Chat](https://discord.gg/qcynkd4Edx) here. +### Contact Information ---- +Join us in our [Discord Chat](https://discord.gg/qcynkd4Edx). ### Terminology freeCodeCamp uses the following terms: -Certification = 'superblock' +`Certification = 'superblock'` -Course(s) = 'blocks' +`Course(s) = 'blocks'` -Everything under a course/block is a 'challenge' +Everything under a course/block is a `'challenge'` ---- +### API + +This project uses multiple APIs from freeCodeCamp. Check out the following and familiarize yourself. + +[Superblock API](https://www.freecodecamp.org/curriculum-data/v1/available-superblocks.json) + +[Blocks API](https://www.freecodecamp.org/curriculum-data/v1/2022/responsive-web-design.json) + +Mock API: Student information - this will be replaced will real student information in the future. It is **not available publicly** yet, you will need to start the application and go to http://localhost:3001/data. ### Tech stack learning resources From 185e494aeb29b662621767e69d0ed4398c5c3288 Mon Sep 17 00:00:00 2001 From: Komal Kaur <44416323+Komal914@users.noreply.github.com> Date: Wed, 25 Oct 2023 16:27:11 -0700 Subject: [PATCH 3/9] Rename gitpod-set-up.md to GITPOD-SET-UP.md --- docs/{gitpod-set-up.md => GITPOD-SET-UP.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{gitpod-set-up.md => GITPOD-SET-UP.md} (100%) diff --git a/docs/gitpod-set-up.md b/docs/GITPOD-SET-UP.md similarity index 100% rename from docs/gitpod-set-up.md rename to docs/GITPOD-SET-UP.md From 7d17b66065f5c222f74ac7f3383f1013fd5cde68 Mon Sep 17 00:00:00 2001 From: Komal Kaur Date: Wed, 25 Oct 2023 16:47:07 -0700 Subject: [PATCH 4/9] added links and organized visually --- docs/GITHUB-CODESPACES-SET-UP.md | 26 +++++++++++++++++++------- docs/LOCAL-DOCKER-SET-UP.md | 26 ++++++++++++++++++++------ docs/gitpod-set-up.md | 18 +++++++++++++----- 3 files changed, 52 insertions(+), 18 deletions(-) diff --git a/docs/GITHUB-CODESPACES-SET-UP.md b/docs/GITHUB-CODESPACES-SET-UP.md index 98cdb6ec2..87d670c95 100644 --- a/docs/GITHUB-CODESPACES-SET-UP.md +++ b/docs/GITHUB-CODESPACES-SET-UP.md @@ -49,18 +49,30 @@ Within freeCodeCamp Classroom, GitHub Codespaces is on par with Gitpod so that y ## Additional Steps to take after finishing Github Codespaces setup: -1.Run: `npm run develop` +1. Open a terminal and paste the following to start the application. -2.Check to see if the website is functional and you can sign in and authorize yourself using your GitHub profile. +```console + npm run develop +``` -3.After successfully signing in, sign out and open a new terminal. +2. Check to see if the website is functional and you can sign in and authorize yourself using your GitHub profile. -4.Run: `npx prisma studio` +3. After successfully signing in, sign out and open a new terminal. -5.In Prisma Studio, go to User. Under the “roles” column, enter TEACHER or ADMIN. And click on the “Save Changes” button. +4. Start the ORM tool, [Prisma Studio](https://www.prisma.io/docs/concepts/overview/what-is-prisma). -6.Run `npm run mock-fcc-data` +```console + npx prisma studio +``` -7.Go to the ports tab and set the visibility to public for the 3000 and 3001 ports. +5. In Prisma Studio, go to User. Under the “roles” column, enter TEACHER or ADMIN. And click on the “Save Changes” button. + +6. Feed in the mock student data being used. + +```console + npm run mock-fcc-data +``` + +7. Go to the ports tab and set the visibility to public for the 3000 and 3001 ports. Happy coding! diff --git a/docs/LOCAL-DOCKER-SET-UP.md b/docs/LOCAL-DOCKER-SET-UP.md index 979ed3d96..356c6b7be 100644 --- a/docs/LOCAL-DOCKER-SET-UP.md +++ b/docs/LOCAL-DOCKER-SET-UP.md @@ -63,11 +63,25 @@ You will need to update the .env file inside your project with the following: ## Additional Steps to take after finishing Local Docker Setup: -5. Run `npx prisma generate`. -6. Run `npx prisma db push`. -7. Run `npx prisma db seed`. -8. Run `npm run develop`. -9. Run `npm run mock-fcc-data` -10. Run `npx prisma studio` +1. Run the following commands in terminal to start your application. + +```console + npx prisma generate + npx prisma db push + npx prisma db seed + npm run develop +``` + +2. Open a new terminal to feed in the mock student information being used. + +```console + npm run mock-fcc-data +``` + +3. Open another terminal and start the ORM tool, [Prisma](https://www.prisma.io/docs/concepts/overview/what-is-prisma). + +```console + npx prisma studio +``` Happy Coding! diff --git a/docs/gitpod-set-up.md b/docs/gitpod-set-up.md index caf1387f1..7e90e1020 100644 --- a/docs/gitpod-set-up.md +++ b/docs/gitpod-set-up.md @@ -45,14 +45,22 @@ Within freeCodeCamp Classroom, Gitpod is on par with Github Codespaces so that y ## Additional Steps to take after finishing Gitpod Setup: -1.Run `npm run develop` +1. Open a terminal and paste the following to start the application. -2.Check to see if the website is functional and you can sign in and authorize yourself using your GitHub profile. +```console + npm run develop +``` -3.After successfully signing in, sign out and open a new terminal. +2. Check to see if the website is functional and you can sign in and authorize yourself using your GitHub profile. -4.Run `npx prisma studio` +3. After successfully signing in, sign out and open a new terminal. -5.In Prisma Studio, go to User. Under the “roles” column, enter TEACHER or ADMIN. And click on the “Save Changes” button. +4. Start the ORM tool, [Prisma Studio](https://www.prisma.io/docs/concepts/overview/what-is-prisma). + +```console + npx prisma studio +``` + +5. In Prisma Studio, go to User. Under the “roles” column, enter TEACHER or ADMIN. And click on the “Save Changes” button. Happy coding! From f8060172b1ab974cbbdc5aa4eea8429dcdbbad8a Mon Sep 17 00:00:00 2001 From: Komal Kaur Date: Wed, 25 Oct 2023 17:04:53 -0700 Subject: [PATCH 5/9] reorganized resources --- README.md | 31 ++++++++++++++----------------- 1 file changed, 14 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 7a1f2c4bb..274f7240c 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ # Classroom -> A self-hosted solution to help teachers plan and manage classroom-based learning, on top of freeCodeCamp's learning platform. +A self-hosted solution to help teachers plan and manage classroom-based learning, on top of freeCodeCamp's learning platform. ## Motivation @@ -67,29 +67,26 @@ This project uses multiple APIs from freeCodeCamp. Check out the following and f Mock API: Student information - this will be replaced will real student information in the future. It is **not available publicly** yet, you will need to start the application and go to http://localhost:3001/data. -### Tech stack learning resources +### Tech Stack Learning Resources -Testing with jest -https://jestjs.io/docs/snapshot-testing +#### Jest Snapshot Testing -Next.js fullstack framework -https://nextjs.org/docs/pages/building-your-application/optimizing/testing#jest-and-react-testing-library -https://dillionmegida.com/p/nextjs-main-concepts/ -https://blog.devgenius.io/advanced-next-js-concepts-8439a8752597 +> We are always in need of more tests! Checkout Jest's [snapshot testing docs](https://jestjs.io/docs/snapshot-testing). We recommend learning snapshot testing as we require tests for each component inside our project. -Next.js terminology: +#### Next.js Fullstack Framework -SSR - Server Side Rendering +> This project utilizes Next.js to optimize performance. We recommend learning [main concepts of Next.js](https://dillionmegida.com/p/nextjs-main-concepts/) and familiarizing yourself on [testing with Next.js](https://nextjs.org/docs/pages/building-your-application/optimizing/testing#jest-and-react-testing-library). -SSG - Static Site Generation +#### Next.js Terminology: -ISR - Incremental Static Regeneration +| Term | Value | +| ---- | ------------------------------- | +| SSR | Server Side Rendering | +| SSG | Static Site Generation | +| ISR | Incremental Static Regeneration | +| CSR | Client Side Rendering | -CSR - Client Side Rendering - -SSR is probably the focus point. - -https://dev.to/mbaljeetsingh/what-is-csr-ssr-ssg-isr-different-rendering-strategies-and-which-framework-does-it-better-angular-react-vue-4lkp +> SSR is probably the focus point. Checkout this [article](https://dev.to/mbaljeetsingh/what-is-csr-ssr-ssg-isr-different-rendering-strategies-and-which-framework-does-it-better-angular-react-vue-4lkp) to understand these concepts and how they are helpful. --- From aa263eb9064aa22b94d8396b560f264c19f2add7 Mon Sep 17 00:00:00 2001 From: Komal Kaur Date: Wed, 25 Oct 2023 17:22:53 -0700 Subject: [PATCH 6/9] minor visual update --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 274f7240c..86f657eea 100644 --- a/README.md +++ b/README.md @@ -88,9 +88,7 @@ Mock API: Student information - this will be replaced will real student informat > SSR is probably the focus point. Checkout this [article](https://dev.to/mbaljeetsingh/what-is-csr-ssr-ssg-isr-different-rendering-strategies-and-which-framework-does-it-better-angular-react-vue-4lkp) to understand these concepts and how they are helpful. ---- - -### License +## License Copyright © 2021 freeCodeCamp.org From ec15cc852a677ad4eafda648c58b886e04d2e992 Mon Sep 17 00:00:00 2001 From: Komal Kaur Date: Wed, 25 Oct 2023 17:31:17 -0700 Subject: [PATCH 7/9] minor detail --- docs/LOCAL-DOCKER-SET-UP.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/LOCAL-DOCKER-SET-UP.md b/docs/LOCAL-DOCKER-SET-UP.md index 356c6b7be..6e7b67a4d 100644 --- a/docs/LOCAL-DOCKER-SET-UP.md +++ b/docs/LOCAL-DOCKER-SET-UP.md @@ -78,7 +78,7 @@ You will need to update the .env file inside your project with the following: npm run mock-fcc-data ``` -3. Open another terminal and start the ORM tool, [Prisma](https://www.prisma.io/docs/concepts/overview/what-is-prisma). +3. Open another terminal and start the ORM tool, [Prisma Studio](https://www.prisma.io/docs/concepts/overview/what-is-prisma). ```console npx prisma studio From d42accdf669884ae1497846f48887918c14eccfb Mon Sep 17 00:00:00 2001 From: Komal Kaur Date: Thu, 2 Nov 2023 16:22:13 -0700 Subject: [PATCH 8/9] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 86f657eea..6f117aa1d 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ For a while now teachers have been asking for a way to get a birds eye view of m ## Contributing -This project supports multiple ways to set up the project. You can use Gitpod, Github Codespaces or locally using Docker. Please use whichever you feel the most comfortable with. We recommend Github Codespaces if you are not sure. +This project supports multiple ways to set up the codebase. You can choose to either to use Gitpod or Github Codespaces for a browser environment or set up locally. Please use whichever you feel the most comfortable with. We recommend Github Codespaces if you are not sure. Please read our contibution [guidelines](https://contribute.freecodecamp.org/#/how-to-contribute-to-the-codebase?id=contributing-to-the-codebase) before making your first pull request. @@ -65,7 +65,7 @@ This project uses multiple APIs from freeCodeCamp. Check out the following and f [Blocks API](https://www.freecodecamp.org/curriculum-data/v1/2022/responsive-web-design.json) -Mock API: Student information - this will be replaced will real student information in the future. It is **not available publicly** yet, you will need to start the application and go to http://localhost:3001/data. +Mock API: Student information - this will be replaced with real student information in the future. It is **not available publicly** yet, you will need to start the application and go to http://localhost:3001/data. ### Tech Stack Learning Resources @@ -75,7 +75,7 @@ Mock API: Student information - this will be replaced will real student informat #### Next.js Fullstack Framework -> This project utilizes Next.js to optimize performance. We recommend learning [main concepts of Next.js](https://dillionmegida.com/p/nextjs-main-concepts/) and familiarizing yourself on [testing with Next.js](https://nextjs.org/docs/pages/building-your-application/optimizing/testing#jest-and-react-testing-library). +> This project utilizes Next.js to optimize performance, such as SEO. We recommend learning [main concepts of Next.js](https://dillionmegida.com/p/nextjs-main-concepts/) and familiarizing yourself on [testing with Next.js](https://nextjs.org/docs/pages/building-your-application/optimizing/testing#jest-and-react-testing-library). #### Next.js Terminology: @@ -86,7 +86,7 @@ Mock API: Student information - this will be replaced will real student informat | ISR | Incremental Static Regeneration | | CSR | Client Side Rendering | -> SSR is probably the focus point. Checkout this [article](https://dev.to/mbaljeetsingh/what-is-csr-ssr-ssg-isr-different-rendering-strategies-and-which-framework-does-it-better-angular-react-vue-4lkp) to understand these concepts and how they are helpful. +> ISR is probably the focus point. Checkout this [article](https://dev.to/mbaljeetsingh/what-is-csr-ssr-ssg-isr-different-rendering-strategies-and-which-framework-does-it-better-angular-react-vue-4lkp) to understand these concepts and how they are helpful. ## License From 911d171d8661694c44aa892e3e9afda87ff94352 Mon Sep 17 00:00:00 2001 From: Komal Kaur Date: Thu, 2 Nov 2023 16:22:13 -0700 Subject: [PATCH 9/9] updated minor deatils > > Co-authored by: Natalia Gill --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 86f657eea..6f117aa1d 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ For a while now teachers have been asking for a way to get a birds eye view of m ## Contributing -This project supports multiple ways to set up the project. You can use Gitpod, Github Codespaces or locally using Docker. Please use whichever you feel the most comfortable with. We recommend Github Codespaces if you are not sure. +This project supports multiple ways to set up the codebase. You can choose to either to use Gitpod or Github Codespaces for a browser environment or set up locally. Please use whichever you feel the most comfortable with. We recommend Github Codespaces if you are not sure. Please read our contibution [guidelines](https://contribute.freecodecamp.org/#/how-to-contribute-to-the-codebase?id=contributing-to-the-codebase) before making your first pull request. @@ -65,7 +65,7 @@ This project uses multiple APIs from freeCodeCamp. Check out the following and f [Blocks API](https://www.freecodecamp.org/curriculum-data/v1/2022/responsive-web-design.json) -Mock API: Student information - this will be replaced will real student information in the future. It is **not available publicly** yet, you will need to start the application and go to http://localhost:3001/data. +Mock API: Student information - this will be replaced with real student information in the future. It is **not available publicly** yet, you will need to start the application and go to http://localhost:3001/data. ### Tech Stack Learning Resources @@ -75,7 +75,7 @@ Mock API: Student information - this will be replaced will real student informat #### Next.js Fullstack Framework -> This project utilizes Next.js to optimize performance. We recommend learning [main concepts of Next.js](https://dillionmegida.com/p/nextjs-main-concepts/) and familiarizing yourself on [testing with Next.js](https://nextjs.org/docs/pages/building-your-application/optimizing/testing#jest-and-react-testing-library). +> This project utilizes Next.js to optimize performance, such as SEO. We recommend learning [main concepts of Next.js](https://dillionmegida.com/p/nextjs-main-concepts/) and familiarizing yourself on [testing with Next.js](https://nextjs.org/docs/pages/building-your-application/optimizing/testing#jest-and-react-testing-library). #### Next.js Terminology: @@ -86,7 +86,7 @@ Mock API: Student information - this will be replaced will real student informat | ISR | Incremental Static Regeneration | | CSR | Client Side Rendering | -> SSR is probably the focus point. Checkout this [article](https://dev.to/mbaljeetsingh/what-is-csr-ssr-ssg-isr-different-rendering-strategies-and-which-framework-does-it-better-angular-react-vue-4lkp) to understand these concepts and how they are helpful. +> ISR is probably the focus point. Checkout this [article](https://dev.to/mbaljeetsingh/what-is-csr-ssr-ssg-isr-different-rendering-strategies-and-which-framework-does-it-better-angular-react-vue-4lkp) to understand these concepts and how they are helpful. ## License