feat: add README.md and LICENSE
This commit is contained in:
parent
ff7b270392
commit
9b7bf4e794
|
@ -0,0 +1,21 @@
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2021 Dawid Wysokiński
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
|
@ -0,0 +1,37 @@
|
||||||
|
# Zdam Egzamin Zawodowy
|
||||||
|
|
||||||
|
![Screenshot](/screenshots/homescreen.jpg?raw=true)
|
||||||
|
|
||||||
|
A mobile app for practising the theoretical part of the [vocational exam](https://cke.gov.pl/en/vocational-examination/).
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
1. Node.JS
|
||||||
|
2. yarn
|
||||||
|
3. [JDK and Android Studio](https://reactnative.dev/docs/environment-setup)
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
1. Clone this repo
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone git@github.com:zdam-egzamin-zawodowy/mobile-app.git
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Navigate to the directory where you have cloned this repo.
|
||||||
|
3. `yarn install`
|
||||||
|
4. `yarn run android` (iOS isn't supported)
|
||||||
|
|
||||||
|
### Firebase (Analytics and Crashlytics)
|
||||||
|
|
||||||
|
Create a new firebase project and add the app `com.dawidwysokinski.zdamegzaminzawodowy`, then download the `google-services.json` file and place it at the following location: `/android/app/google-services.json`.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Distributed under the MIT License. See `LICENSE` for more information.
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me)
|
Binary file not shown.
After Width: | Height: | Size: 294 KiB |
Reference in New Issue