challenge

.gitignore

@@ -1 +1,23 @@
-node_modules
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.prettierrc

@@ -0,0 +1,19 @@
+{
+    "arrowParens": "avoid",
+    "bracketSpacing": false,
+    "embeddedLanguageFormatting": "auto",
+    "htmlWhitespaceSensitivity": "css",
+    "insertPragma": false,
+    "jsxBracketSameLine": false,
+    "jsxSingleQuote": false,
+    "printWidth": 80,
+    "proseWrap": "always",
+    "quoteProps": "as-needed",
+    "requirePragma": false,
+    "semi": true,
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "all",
+    "useTabs": false,
+    "vueIndentScriptAndStyle": false
+  }

README.md

@@ -1,9 +1,16 @@
 # Sheypoor frontend-challenge
 
-The task is to implement a **2 step UI wizard** to create a user account. There is no UX or UI constraints, this is 
-up to you to decide. 
+## Installation
+
+- `Clone repo`
+- `npm install or yarn install`
+- `yarn start or npm start`
+
+The task is to implement a **2 step UI wizard** to create a user account. There
+is no UX or UI constraints, this is up to you to decide.
 
 The User information that we need to collect is described in the User type:
+
 ```
 interface User {
   name: string
@@ -12,13 +19,14 @@ interface User {
   newsletter: 'daily' | 'weekly' | 'monthly'
 }
 ```
-You can, for example collect the name and age in the first step and then email and newsletter in the second step.
-You may use a routing library such that every step is a separate route but this is completely optional and not 
-required.
 
-There is a dummy `sdk` package(implemented in the /sdk folder) which exports a `createUser` function. This function returns a `Promise`.
-Use it to simulate a request that creates a user account. 
-Ex:
+You can, for example collect the name and age in the first step and then email
+and newsletter in the second step. You may use a routing library such that every
+step is a separate route but this is completely optional and not required.
+
+There is a dummy `sdk` package(implemented in the /sdk folder) which exports a
+`createUser` function. This function returns a `Promise`. Use it to simulate a
+request that creates a user account. Ex:
 
 ```
 import { createUser } from 'sdk'
@@ -28,22 +36,25 @@ const details = {...}
 createUser(details).then( ... )
 ```
 
-The focus should be on code style and the way you approach the problem implementation wise.
-Feel free to use any other helper library although ideally the more code you write yourself the better.
+The focus should be on code style and the way you approach the problem
+implementation wise. Feel free to use any other helper library although ideally
+the more code you write yourself the better.
 
 ### Implementation requirements:
 
-- use either vanilla Javascript or one of the frameworks we use at Sheypoor(React / Knockout.js) or whatever you like
-- use npm to manage dependencies, there is pre-initialized package.json included in this repo
+- use either vanilla Javascript or one of the frameworks we use at
+  Sheypoor(React / Knockout.js) or whatever you like
+- use npm to manage dependencies, there is pre-initialized package.json included
+  in this repo
 
 ### Getting started:
 
 - Fork the repo
 - Implement your solution
 - Create a PR against this repo
 
-Optional: build the project and deploy (ie make it available as a static project) on 
-[Github Pages](https://pages.github.com/), otherwise please provide detailed instructions
-on how to start the project locally.
+Optional: build the project and deploy (ie make it available as a static
+project) on [Github Pages](https://pages.github.com/), otherwise please provide
+detailed instructions on how to start the project locally.
 
 Any questions please contact us via email (jobs AT sheypoor.com) :)