[App] Proffy

This app version allow everyone to see all open incidents from all NGOs. All the resources used by this application comes from its API.

Table of Contents

• Screenshots
• Installing
  • Configuring
    • .env
    • API
• Usage
  • Expo
• Running the tests
  • Coverage report

Screenshots

Click to expand.

Installing

Easy peasy lemon squeezy:

$ yarn

Or:

$ npm install

Was installed and configured the eslint and prettier to keep the code clean and patterned.

Configuring

Configure your environment variables and remember to start the API before to start this app.

.env

In this file you may configure the API's url. Rename the .env.example in the root directory to .env then just update with your settings.

key	description	default
API_URL	API's url with version (v1)	http://localhost:3333/v1

API

Start the API (see its README for more information). In case of any change in the API's port or host remember to update the env's API_URL property too.

Also, maybe you need run reverse command to the API's port: adb reverse tcp:3333 tcp:3333

Usage

To start the app run:

$ yarn start

Or:

$ npm run start

This project was built with Expo, to know how to run the app see Expo Go.

Running the tests

Jest was the choice to test the app, to run:

$ yarn test

Or:

$ npm run test

Coverage report

You can see the coverage report inside tests/coverage. They are automatically created after the tests run.