Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/diegovictor/gobarber-app

Project developed during the Rocketseat Bootcamp #11 with React Native
https://github.com/diegovictor/gobarber-app

editorconfig eslint figma gobarber javascript js node nodejs prettier react react-native rn rocketseat ts typescript

Last synced: 14 days ago
JSON representation

Project developed during the Rocketseat Bootcamp #11 with React Native

Host: GitHub
URL: https://github.com/diegovictor/gobarber-app
Owner: DiegoVictor
License: mit
Created: 2019-09-21T14:37:11.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-04-13T15:18:27.000Z (9 months ago)
Last Synced: 2024-04-14T10:59:26.143Z (9 months ago)
Topics: editorconfig, eslint, figma, gobarber, javascript, js, node, nodejs, prettier, react, react-native, rn, rocketseat, ts, typescript
Language: TypeScript
Homepage:
Size: 8.61 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 18
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # [App] GoBarber

[![CircleCI](https://img.shields.io/circleci/build/github/DiegoVictor/gobarber-app?style=flat-square&logo=circleci)](https://app.circleci.com/pipelines/github/DiegoVictor/gobarber-app)

[![react-native](https://img.shields.io/badge/react--native-0.73.6-61dafb?style=flat-square&logo=react)](https://reactnative.dev/)

[![styled-components](https://img.shields.io/badge/styled_components-6.1.8-db7b86?style=flat-square&logo=styled-components)](https://styled-components.com/)

[![eslint](https://img.shields.io/badge/eslint-8.57.0-4b32c3?style=flat-square&logo=eslint)](https://eslint.org/)

[![airbnb-style](https://flat.badgen.net/badge/style-guide/airbnb/ff5a5f?icon=airbnb)](https://github.com/airbnb/javascript)

[![jest](https://img.shields.io/badge/jest-29.7.0-brightgreen?style=flat-square&logo=jest)](https://jestjs.io/)

[![coverage](https://img.shields.io/codecov/c/gh/DiegoVictor/gobarber-app?logo=codecov&style=flat-square)](https://codecov.io/gh/DiegoVictor/gobarber-app)

[![MIT License](https://img.shields.io/badge/license-MIT-green?style=flat-square)](https://raw.githubusercontent.com/DiegoVictor/gobarber-app/main/LICENSE)

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

This app version allow users to register yourself, reset or change password, email or name and to schedule appointments with providers. All the resources used by this application comes from its [`API`](https://github.com/DiegoVictor/gobarber-api).

## Table of Contents

* [Screenshots](#screenshots)

* [Installing](#installing)

  * [Configuring](#configuring)

    * [.env](#env)

    * [API](#api)

* [Usage](#usage)

  * [OS](#os)

* [Running the tests](#running-the-tests)

  * [Coverage report](#coverage-report)

# Screenshots

Click to expand.
















# Installing

Easy peasy lemon squeezy:

```

$ yarn

```

Or:

```

$ npm install

```

> Was installed and configured the [`eslint`](https://eslint.org/) and [`prettier`](https://prettier.io/) to keep the code clean and patterned.

## Configuring

Configure your environment variables and remember to start the [API](https://github.com/DiegoVictor/gobarber-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|`http://localhost:3333`

### API

Start the [`API`](https://github.com/DiegoVictor/gobarber-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

The first build must be through USB connection, so connect your device (or just open your emulator) and run:

```

$ yarn android

```

Or:

```

$ npx react-native run-android

```

In the next times you can just run the Metro Bundler server:

```

$ yarn start

```

Or:

```

$ npm run start

```

> See for more information in [Running On Device](https://reactnative.dev/docs/running-on-device).

## OS

This app was tested only with Android through USB connection and [Genymotion](https://www.genymotion.com/) (Emulator), is strongly recommended to use the same operational system, but of course you can use an emulator or a real device connected through wifi or USB.

# Running the tests

[Jest](https://jestjs.io/) 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.