https://github.com/eiberham/carb-manager
Card Component
https://github.com/eiberham/carb-manager
Last synced: 3 months ago
JSON representation
Card Component
- Host: GitHub
- URL: https://github.com/eiberham/carb-manager
- Owner: eiberham
- Created: 2021-06-28T15:46:30.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-28T15:48:09.000Z (about 5 years ago)
- Last Synced: 2025-05-20T19:22:28.521Z (about 1 year ago)
- Language: Vue
- Size: 4.25 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Carb Manager Dev Assignment
## Design
**Card:**
**Hover:**
20% opacity white fill when hovering over the card.
**Figma Link:**
[https://www.figma.com/file/Hv0bOihxG5M40ASYsFBrVR/Interview-Assignment?node-id=0%3A1](https://www.figma.com/file/Hv0bOihxG5M40ASYsFBrVR/Interview-Assignment?node-id=0%3A1)
---
## Assignment Requirements:
### Data
- Retrieve the recipe JSON data via HTTP from https://60c10ba2b8d367001755666e.mockapi.io/recipe/1
- Transform the data if required
- Use that data to render the `` component
### UI
- Translate the design as closely as possible to custom CSS. We've also provided hover styles for you to replicate.
- Use SVG's for the custom icons. These can be grabbed from the Figma file.
- Make sure the Recipe title gets truncated after 2 lines
- The star ratings should be able to work with half-stars.
- If a recipe duration is longer than 60 minutes, the format should be `x hr x min`
- Add an `energy-units` prop which will take either `calories` (default) or `kilojoules`. This will determine which energy value/unit to display. 1 calorie = 4.184 kJ. The number value passed in as a prop will always represent calories, so if `kilojoules` is selected, a conversion needs to take place.
### Interactions
- The whole card will be clickable. Make sure that the event is working properly. You should see a "clicked" message in the Storybook "actions" tab when clicking on the component.
- Because the whole card is clickable, the "heart" icon in the top right won't be interactive. Instead, it should be empty or filled in depending on a certain prop value.
### Storybook
Create a Storybook story to view the component in isolation and to be able to interact with all available props.
There is a `PremiumRecipeCard.stories.js` placeholder file that you can use to get started. Take a look at the [addon-knobs](https://www.npmjs.com/package/@storybook/addon-knobs) documentation to help you get started if you are unfamiliar with Storybook.
### Tests
There is a `PremiumRecipeCard.spec.js` file which you can use to write some tests. These tests are completely up to you. Try to come up with some useful test cases.
**Hint:** The calorie -> kilojoules conversion will be a good test case to make sure the conversion is working properly.
### Other Notes
- **Clone** the repo (not fork) to get started. Please don't create everything with just one commit. We would love to see how you structure your commits.
- Don't feel like you have to stay within the placeholder files. If you want to create some helper/utility functions, go ahead and create the appropriate file/folders for that.
- If you see any elements inside of this Recipe Card design that could be useful to re-use in other areas, feel free to split them out into their own sub components. Don't overengineer it by breaking every single element out, but there might be some that would be better off as small, re-usable components.
- If you do decide to create sub components, bonus points for creating their own stories & tests :)
- Macro dots
- Red: Carbs
- Blue: Protein
- Yellow: Fats
- If you are unclear about something or want to run something by the team, please feel free to reach out. We like to get a sense of how you would work/collaborate on a real task.
- Send us over the GitHub URL when you are complete so we can check it out!
### Reusability
Keep in mind that there may be other variations of the Recipe Card design. Take a look at this **Recipe of the Day** card design:
Don't build out this component (unless you have extra time), but please explain how you would build out this `` component with maximum code re-use from the ``, as they mostly share the same data props with just a tweaked design.
You can send that over to us via email/Slack when you are done with the assignment, or you can just include it in the README file, whatever works best!
## Project setup
```
yarn install
```
### Compiles and hot-reloads for development
```
yarn serve
```
### Run Storybook
```
yarn storybook
```
### Run your unit tests
```
yarn test:unit
```