Merge pull request #16 from SafdarJamal/release/v5.0.0

Release v5.0.0

.github/workflows/node.js.yml

@@ -0,0 +1,30 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master, development ]
+  pull_request:
+    branches: [ master, development ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x, 15.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test

.gitignore

@@ -1,3 +1,5 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
 # dependencies
 /node_modules
 /.pnp
@@ -19,3 +21,5 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+.eslintcache

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2020 Safdar Jamal
+Copyright (c) 2019-2021 Safdar Jamal
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,18 +1,32 @@
-# The QuizApp
+<h1 align="center">
+  <a href="https://safdarjamal.github.io/quiz-app/">
+    QuizApp
+  </a>
+</h1>
 
-The QuizApp is a progressive web app ([PWA](https://developers.google.com/web/progressive-web-apps)) built with [React](https://reactjs.org) using [OpenTDB](https://opentdb.com) API.
+<p align="center">
+  <a href="https://github.com/SafdarJamal/quiz-app/actions?query=workflow%3A%22Node.js+CI%22">
+    <img src="https://github.com/SafdarJamal/quiz-app/workflows/Node.js%20CI/badge.svg" alt="Node.js CI" />
+  </a>
+  <a href="https://github.com/SafdarJamal/quiz-app/releases">
+    <img src="https://img.shields.io/github/v/release/SafdarJamal/quiz-app" alt="GitHub Release (latest by date)" />
+  </a>
+  <a href="https://github.com/SafdarJamal/quiz-app/blob/master/LICENSE">
+    <img src="https://img.shields.io/github/license/SafdarJamal/quiz-app" alt="License" />
+  </a>
+</p>
 
 <p align="center">
-  <img src="./screenshot.png" alt='QuizApp in Action'>
+  QuizApp is a free and open-source quiz application that lets you play fully customize quizzes right in the browser.
 </p>
 
-## Demo
+![quiz-app](https://user-images.githubusercontent.com/48409548/104132046-a39e5b80-539c-11eb-9df3-28d52e499a6c.png)
 
-- [master](https://safdarjamal.github.io/quiz-app) (Latest)
-- [v4.0](https://quizapp-v4.surge.sh) (Create Q/A dashboard)
-- [v3.0](https://quizapp-v3.surge.sh) (Play fully customize quiz and its now a PWA)
-- [v2.0](https://quizapp-v2.surge.sh) (Add countdown timer and some UI enhancement)
-- [v1.0](https://quizapp-v1.surge.sh) (Basic 10 questions quiz)
+## Built with
+
+- [React](http://reactjs.org)
+- [Semantic UI](https://semantic-ui.com)
+- [Open Trivia Database API](https://opentdb.com/api_config.php)
 
 ## Development
 
@@ -29,13 +43,17 @@ Install dependencies:
 npm install
 ```
 
-Finally, you need to start a local web server. Run:
+Now, you can start a local web server by running:
 
 ```
 npm start
 ```
 
-#### npm scripts
+And then open http://localhost:3000 to view it in the browser.
+
+#### Available Scripts
+
+In this project, you can run the following scripts:
 
 | Script        | Description                                                             |
 | ------------- | ----------------------------------------------------------------------- |
@@ -44,6 +62,10 @@ npm start
 | npm run build | Builds the app for production to the `build` folder.                    |
 | npm run eject | This command will remove the single build dependency from your project. |
 
+## Credits
+
+QuizApp is built and maintained by [Safdar Jamal](https://safdarjamal.github.io).
+
 ## License
 
-Code released under the [MIT License](https://github.com/SafdarJamal/quiz-app/blob/master/LICENSE).
+Code released under the [MIT license](https://github.com/SafdarJamal/quiz-app/blob/master/LICENSE).