Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arrudadev/pet-feeder-mobile

Mobile application from the Integration Project 6 of the college.
https://github.com/arrudadev/pet-feeder-mobile

expo firebase react-native styled-components typescript

Last synced: about 1 month ago
JSON representation

Mobile application from the Integration Project 6 of the college.

Awesome Lists containing this project

README

        


Pet Feeder Mobile

[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

> Mobile application from the Integration Project 6 of the college.

Through this application the user can manage their pets and how much ration should be given to each pet.

Login Page

# :pushpin: Table of Contents

* [Technologies](#-technologies)
* [Installation](#construction_worker-installation)
* [Getting Started](#runner-getting-started)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)

## 💻 Technologies

This project was developed with the following technologies:

- [Typescript](https://www.typescriptlang.org/)
- [React Native](https://reactnative.dev/)
- [Expo](https://reactnative.dev/)
- [Styled Components](https://styled-components.com/)
- [Firebase](https://firebase.google.com/)

# :construction_worker: Installation

**You need to install [Node.js](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com/) first, then in order to clone the project via HTTPS, run this command:**

```
git clone https://github.com/monteiro-alexandre/pet-feeder-mobile.git
```

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you use a SSH key registered in your Github account, clone the project using this command:

```
git clone [email protected]:monteiro-alexandre/pet-feeder-mobile.git
```

Remember that you will need to create a [Firebase](https://firebase.google.com/) account.

**Install dependencies**

```
yarn install
```

Or

```
npm install
```

Create your environment variables based on the examples of environment.example.ts

```
cp environment.example.ts environment.ts
```

After copying the examples, make sure to fill the variables with new values. to run locally you can fill the development environment. if you will use your cell phone for the test, make sure you have point your machine ip address in apiUrl and not use localhost.

# :runner: Getting Started

Run the following command to start Expo DevTools:

```yarn start```

Than you can open the app in your cell phone using the Expo client app for IOS and Android, see:

[Expo Documentation](https://docs.expo.dev/get-started/installation/#2-expo-client-app-for-ios-and).

# :bug: Issues

Feel free to **file a new issue** with a respective title and description on the the [Pet Feeder Mobile](https://github.com/monteiro-alexandre/pet-feeder-mobile/issues) repository. If you already found a solution to your problem, **I would love to review your pull request**! Have a look at our [contribution guidelines](https://github.com/monteiro-alexandre/pet-feeder-mobile/blob/main/CONTRIBUTING.md) to find out about the coding standards.

# :tada: Contributing

Check out the [contributing](https://github.com/monteiro-alexandre/pet-feeder-mobile/blob/main/CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.

# :closed_book: License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.