Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DONE: added readme #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,45 @@
# nums-api-m

NumbersAPI mobile is a cross-platform smartphone application built with react-native-app using Ionic.
Gets data from [NumbersAPI](http://numbersapi.com/) API.

Fetches data from four different categories: Math, Trivia, Date, Year.

Home page has documentation about the functionality of the NumbersAPI webpage API.

Select category from nav bar at the bottom of the screen.
Each category can either generate a random fact or a fact based on the numeric input.
- If the input field is empty, button will generate a random fact.
- If the input field has a number it will generate a specific fact.
- non numeric input will throw an error.

## Setting Up Dev Environment

### Create React Native App

Create React Native App was used for the development environment. If you have issue setting up with Expo CLI or React Native CLI, [Create React Native App](https://reactnative.dev/blog/2017/03/13/introducing-create-react-native-app) is recommended.


### Ionic

Built using [Ionic's](https://ionicframework.com/getting-started#install) component based framework.


### Running the application

To run the application in your browser
```
ionic serve
```

To run in a simulator

ios:
```
ionic capacitor run ios
```

andriod:
```
ionic capacitor run android
```
9 changes: 9 additions & 0 deletions ios/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
App/build
App/Pods
App/Podfile.lock
App/App/public
DerivedData
xcuserdata

# Cordova plugins for Capacitor
capacitor-cordova-ios-plugins
Loading