Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update file structure and example functions and corresponding test files #418

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Kalikoze
Copy link
Contributor

Description of changes made

  • Changes made were made to match the changes made to the corresponding What's Cookin starter kit.
  • Updated the name of the test file to no longer resemble a class.
  • Given additional file structure so students know to move their logic outside of the scripts into separate files such as users, hydration, and more.
  • Updated some of the example functions to give students a base idea on how to initially set things up.

Motivation for any changes

  • I've renamed the test file since we are no longer using classes.
  • In the past, we've had multiple students run into errors like document not found when trying to run the tests. This error can be a bit confusing as the boilerplate doesn't reference document in the beginning but is caused by the import styles.css file. Also there was an existing error when running npm t.
  • I've also updated some of the example functions to help students get a better idea of how to structure their logic. Given that this is the first time they are doing this, I figured a small hint would help prevent them from running into too many webpack errors or file issues. (which is not one of the main learning goals of this project)

Questions that you have for a reviewer

  • When you install the application and run npm start, does the app open correctly?
  • When running npm test, does the test successfully pass?
  • Are the file names following good practices? Or do you have other recommendations?
  • Do the current functions offer enough support without giving too much guidance?

@Kalikoze Kalikoze requested a review from kaylagordon January 30, 2024 17:58
@kaylagordon
Copy link

When you install the application and run npm start, does the app open correctly?

  • YES

When running npm test, does the test successfully pass?

  • YES

Are the file names following good practices? Or do you have other recommendations?

  • Looks good to me!

Do the current functions offer enough support without giving too much guidance?

  • YES

Note - I added one small commit to add spaces between some of the content of scripts.js for readability.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants