Skip to content

Commit

Permalink
Merge pull request #35 from xmartinezpujol/xmartinezpujol/improveReadme
Browse files Browse the repository at this point in the history
 Describe the project
  • Loading branch information
Xavier Martínez Pujol committed Oct 5, 2019
2 parents cbdd00a + fb6956b commit ce5a983
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 3 deletions.
60 changes: 59 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,62 @@

A React app to test Frontend questions like a Quiz

![Frontend Quiz](https://raw.githubusercontent.com/xmartinezpujol/frontend-quizz/master/public/img/quizApp.png)
<img alt="Frontend Quiz" src="https://raw.githubusercontent.com/xmartinezpujol/frontend-quizz/master/public/img/quizApp.png" width="350" />

##Motivation

In technical interviews it's pretty common to face quiz-like rounds of your programming language of choice. The idea behind frontend-quiz is to help you practice on a daily basis this exercises in a constant and practical way.

It started as a way to improve in JS questions but this can be extended to other languages and even become a generic Trivia Quiz!

##Future Plans

My time is currently limited so I'm just adding some new questions from time to time, but my idea is to keep adding new features. Feel free to contribute with ideas also!

* Score system to keep track of your daily improvements.
* Sharing system, for scores, single questions or event custom quizzes.
* Import/Export JSON files for Quiz data. That way maybe we can allow users to create their own tests and share them with friends.
* Keep it Offline. Simplicity, no data consumption, blazing fast.

##Getting Started

### Client localhost (http://localhost:5000)
Node/NPM required to install dependencies.

Clone rep
``` shell
git clone git@github.com:xmartinezpujol/frontend-quiz.git
```

Install dependencies
``` shell
npm install
```

Start development
``` shell
npm start
```

Make Production Bundle
``` shell
npm run build
```

### Testing

* Unit & Snapshot tests done in Jest.

``` shell
npm run test
```

* Integration/E2E tests done in Cypress.

``` shell
npm run teste2e
```

##Contributing

This is an open-source project and will stay that way forever. If you want to contribute, feel free to open a Issue/PR explaining your idea or contribute to existing issues. Thank you!
2 changes: 0 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,6 @@
"test": "jest --env=jsdom --coverage",
"teste2e": "cypress open",
"test:output": "jest --json --outputFile=.jest-test-results.json",
"storybook": "start-storybook -p 6006 -s ./public",
"build-storybook": "build-storybook",
"snyk-protect": "snyk protect",
"prepare": "npm run snyk-protect"
},
Expand Down

0 comments on commit ce5a983

Please sign in to comment.