This repository has been archived by the owner on Sep 2, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
76 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) NJUCSE17 and its affiliates. | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# JB-App | ||
|
||
Mobile application of [JB-Online](https://github.com/NJUCSE17/JB-Online). Built with React Native and Expo. | ||
|
||
Legacy (Java) version of this app can be found at [JB-App-Legacy](https://github.com/NJUCSE17/JB-App-Legacy), but it is no longer maintained. | ||
|
||
## Getting Started | ||
|
||
### Project Structure | ||
|
||
``` | ||
+-assets -> Save fonts and images | ||
|-components -> Reusable single components | ||
|-constants -> Theme, style and other constants | ||
|-navigation -> Routes and navigation config | ||
|-screens -> Screens of navigation | ||
|-services -> API and its config | ||
|-App.js -> Main entrance of this app | ||
`-app.json -> APP related config | ||
``` | ||
|
||
### Run, Test and Build | ||
|
||
- Please use yarn instead of npm as package manager. | ||
- Run `yarn start` or `expo start` to start development server. | ||
- Keep `/services/config.json` excluded from git. | ||
- Run `expo build:[platform]` to build a standalone app. | ||
|
||
References: | ||
|
||
- [React Native documentation](https://facebook.github.io/react-native/docs/getting-started.html) | ||
- [Expo documentation](https://docs.expo.io/) | ||
- [Native Base documentation](https://docs.nativebase.io) | ||
|
||
### JavaScript is Bad! | ||
|
||
You can use TypeScript instead. We are considering changing all JS files to TS. | ||
|
||
## License and Credit | ||
|
||
JB-App is MIT licensed. | ||
|
||
Credits to | ||
|
||
- [Axios](https://github.com/axios/axios) | ||
- [Expo](https://expo.io) and Expo SDK | ||
- [js-base64](https://github.com/dankogai/js-base64) by dankogai | ||
- [Native Base](https://github.com/GeekyAnts/NativeBase) by GeekyAnts | ||
- [qs](https://github.com/ljharb/qs) by ljharb | ||
- [React Native](https://github.com/facebook/react-native) by Facebook | ||
- Icon from FlatIcon and FontAwesome |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters