Skip to content

Commit 8375bc8

Browse files
chore: Add LICENSE, README and CHANGELOG
1 parent 013d237 commit 8375bc8

File tree

3 files changed

+114
-0
lines changed

3 files changed

+114
-0
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
5+
6+
## [1.0](../../releases/tag/v1.0)
7+
- First Version

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2019 Vin Busquet
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# React Native Trivia Quiz
2+
3+
React Native Trivia Quiz app. The questions are requested using [Open Trivia Database API](https://opentdb.com/).
4+
5+
## Getting Started
6+
7+
These instructions will get you a copy of the project up and running on your local machine for development and testing
8+
purposes.
9+
10+
### Prerequisites
11+
12+
The project can be built with npm or yarn, so choose one of the approach bellow in case you don't
13+
have any installed on your system.
14+
15+
* Yarn is a package manager built by Facebook Team and seems to be faster than npm in general. [Download Yarn](https://yarnpkg.com/en/docs/install) (RECOMMENDED).
16+
17+
or
18+
19+
* npm is distributed with Node.js which means that when you download Node.js,
20+
you automatically get npm installed on your computer. [Download Node.js](https://nodejs.org/en/download/)
21+
22+
### Installing
23+
24+
To download the project follow the instructions bellow
25+
26+
```
27+
git clone https://github.com/computationalcore/react-native-trivia-quiz
28+
cd react-native-trivia-quiz
29+
```
30+
31+
Install dependencies and run with:
32+
33+
yarn
34+
```
35+
yarn install
36+
yarn start
37+
```
38+
or
39+
40+
npm
41+
```
42+
npm install
43+
npm start
44+
```
45+
## How to Play
46+
47+
- Open the app
48+
- Click at "Start Quiz" button
49+
- Answer each one of the ten questions by choosing one of the options
50+
- When all questions are answered it shows the game over screen with total score and elapsed time
51+
52+
## Assets Credits
53+
54+
#### Animations
55+
56+
* [Loading Hamster](https://lottiefiles.com/2151-loading-hamster) by [Nabeel Shah](https://lottiefiles.com/nabeelshah7)
57+
58+
* [Connection error](https://lottiefiles.com/4386-connection-error) by [Lorena Villanueva García](https://lottiefiles.com/lorenavillanueva)
59+
60+
#### Fonts
61+
62+
* [Saucer BB Font](https://www.1001fonts.com/saucer-bb-font.html) by [Blambot Comic Fonts](https://www.1001fonts.com/users/blambot/)
63+
64+
* [Grinched Font](https://www.1001fonts.com/grinched-font.html) by [Sharkshock](https://www.1001fonts.com/users/sharkshock/)
65+
66+
* [BadaBoom BB Font](https://www.1001fonts.com/badaboom-bb-font.html) by [Blambot Comic Fonts](https://www.1001fonts.com/users/blambot/)
67+
68+
#### Images
69+
* [Faq free icon](https://www.flaticon.com/free-icon/faq_1580270) by [Freepik](https://www.flaticon.com/authors/freepik) from [www.flaticon.com](https://www.flaticon.com)
70+
71+
72+
## Authors
73+
Vin Busquet
74+
* [https://github.com/computationalcore](https://github.com/computationalcore)
75+
76+
## License
77+
78+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
79+
80+
## Changelog
81+
82+
For details, check out [CHANGELOG.md](CHANGELOG.md).
83+
84+
## Acknowledgments
85+
* [Open Trivia DB](https://opentdb.com/)
86+
* [Crowdbotics](https://www.crowdbotics.com/)

0 commit comments

Comments
 (0)