tinkertrain/ui-eng-test-potato-app

UI Engineer Hiring Project (Engineering Team)

โ˜… 0Forks 0JavaScriptGitHub โ†—Compare

Project website โ†—

README

๐Ÿฅ” Potato App

UI Engineer Hiring Project (Engineering Team)

๐Ÿ’ช Challenge

Check out the challenge notes for details on project requirements and submission.

๐Ÿ›  Prerequisite

A working Node dev environment (LTS recommended). This project was scaffolded with Create React App. CRA uses Yarn out-of-the-box. You don't have to use Yarn. npm works just fine ๐Ÿ‘.

๐Ÿ”ง Setup

Fork/clone/download this repo it to your computer.

Go into that directory and install dependencies by running:

yarn

Or:

npm install

๐Ÿ“‚ File structure

Below are notable folders in this project:

/ui-eng-test-potato-app
|- src/
|   \- components/
\- stories/

components

The component files will be located under src/components.

stories

The Storybook files are located under stories/

๐Ÿ•น Development

This project is basically an out-of-the-box Create React App project, that was generated via create-react-app.

Fire up the local Storybook server by running:

yarn run storybook

Visit the dev environment at http://localhost:9009/.

โš—๏ธ Testing

The only test suite set up is powered by Jest. To get that setup, install dependencies by running:

yarn

To run the tests, run this command:

yarn run test

Issues