Nezam

.gitignore

@@ -1 +1,24 @@
+# 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*
 node_modules

README.md

@@ -1,49 +1,25 @@
-# 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. 
-
-The User information that we need to collect is described in the User type:
+# Hi, I'm Mohamad Nezam!
+# Sheypoor FrontEnd Challenge
+In this project, I decided to implement a simple two-step UI to sign up for the newsletter
+## API Reference
+#### createUser
+```http
+ src / SDK
 ```
-interface User {
-  name: string
-  age: number
-  email: string
-  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:
-
-```
-import { createUser } from 'sdk'
-
-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.
-
-### 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
-
-### 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.
-
-Any questions please contact us via email (jobs AT sheypoor.com) :)
+| Parameter | Type | Description |
+| :-------- | :------- | :------------------------- |
+| `name` | `string` | **Required** |
+| `age` | `number` | **Required** |
+| `email` | `string` | **Required** |
+| `newsletter` | `'daily' ,'weekly' , 'monthly'`| **Required** |
+## Author
+- [@Mohamad Nezam github](https://www.github.com/MrNezamDeveloper)
+## Used By
+This project is used by the following companie:
+- Sheypoor
+## Links
+[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-thebadge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/nezam-mohamad09123363786/)
+## Tech Stack
+**Client:** React, TypeScript , Reactstrap , React Hook Form , Saas
+**Server:** dummy sdk package
+![Logo](https://www.sheypoor.com/x/imgs/QE4lApai.svg)