freeCodeCamp / classroom

BSD 3-Clause "New" or "Revised" License
144 stars 121 forks source link

Amend README.md with tips from CodeDay Labs Mentor @ngillux (Natalia Gill) #378

Closed lloydchang closed 1 year ago

lloydchang commented 1 year ago

Describe the issue Amend README.md with tips from CodeDay Labs Mentor @ngillux (Natalia Gill)

To Reproduce See https://github.com/freeCodeCamp/classroom/blob/main/README.md

Expected behavior Add the following to https://github.com/freeCodeCamp/classroom/blob/main/README.md



Tips from CodeDay Labs Mentor @ngillux (Natalia Gill)


freeCodeCamp uses the following terms: Certification = 'superblock' Course (s) = 'blocks' Everything under a course/block is a 'challenge'


Not sure if you already had this in your resources but I highly recommend this channel! https://youtu.be/Y6KDk5iyrYE


Try the steps in this discussion post (nvm install 16 and npm ci).


  1. Always make sure postgres is running 'sudo service postgresql start' to start
  2. Make sure PORTS 3001 & 3000 are public
  3. npm run develop
  4. npm run mock-fcc-data
  5. If you go to the classes page and see a blank page, you might need to change your user role in Prima to 'TEACHER'. To do this type npx prisma studio then click 'User' in prisma studio and update 'role a' under your user to be TEACHER and save

https://jestjs.io/docs/snapshot-testing


https://nextjs.org/docs/pages/building-your-application/optimizing/testing#jest-and-react-testing-library


This tutorial/resource on testing a Next.js app with Jest is incredibly helpful, I recommend going through it to get comfortable using Jest with Next.js.


Following up with the above^ if you prefer video tutorials check this out. I recommend listening to his tidbit the first few seconds but the tutorial starts at 1:06. Important information specifically at the 5 minute mark. There is a blog post to complement this video tutorial. Keep in mind we use node package manager 'npm' and not yarn. Please let me know if any questions come up if you view this resource.


This is just a tip for all mentees working on any classroom issues; I think it’s important to try your best to understand core Next.js concepts, and take the time as you need. No need to rush. That’s the core of this project. I wanted to share some starter blogs which can help you think of further concepts to explore in the documentation. So any concept you’re not too sure of you can type a search like : Next.js data fetching Next.js getServerSideProps (Those above 2 topics I highly recommend reviewing) Please check out these articles https://dillionmegida.com/p/nextjs-main-concepts/ https://blog.devgenius.io/advanced-next-js-concepts-8439a8752597

Also the following terminology: SSR - Server Side Rendering SSG - Static Site Generation ISR - Incremental Static Regeneration 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

Also to follow up on the above, I don’t mean learn everything there is to know about Next.js, just the main concepts (and you can go in depth as needed). So depending on what your task is asking of you, you may want to focus on a specific Next.js concept that is present in your task (or knowledge of some concept that may be needed to complete the task).



Additional context I learned these tips from CodeDay Labs Mentor @ngillux (Natalia Gill) via CodeDay Labs Slack channel #natalia-gill at https://codedayorg.slack.com/archives/C05E9LWCYRZ

lloydchang commented 1 year ago

👆 @ngillux Please see above per our Slack conversation in CodeDay Labs at https://codedayorg.slack.com/archives/C05E9LWCYRZ/p1690041029236379 Thank you!

Would you please review #378 and #380 and add a comment that they look good to you? Thank you!

Context: I found your tips in this #natalia-gill channel useful hence I created

Why: Not all the CodeDayLabs mentees assigned to freeCodeCamp Classroom are in this #natalia-gill channel, hence having your tips in README.md would be helpful to them, and anyone else new to freeCodeCamp Classroom.

Thanks again!