Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/laurabeatris/gobarber-web

Manage appointments in barbershops - Built with React Native and Styled Components
https://github.com/laurabeatris/gobarber-web

frontend react reactjs styled-components typescript

Last synced: 17 days ago
JSON representation

Manage appointments in barbershops - Built with React Native and Styled Components

Awesome Lists containing this project

README

        



# Go Barber

> Schedule and manage appointments in barber shops

[![Author](https://img.shields.io/badge/author-LauraBeatris-ff9000?style=flat-square)](https://github.com/LauraBeatris)
[![Languages](https://img.shields.io/github/languages/count/LauraBeatris/gobarber-web?color=%23ff9000&style=flat-square)](#)
[![Stars](https://img.shields.io/github/stars/LauraBeatris/gobarber-web?color=ff9000&style=flat-square)](https://github.com/LauraBeatris/gobarber-web/stargazers)
[![Forks](https://img.shields.io/github/forks/LauraBeatris/gobarber-web?color=%23ff9000&style=flat-square)](https://github.com/LauraBeatris/gobarber-web/network/members)
[![Contributors](https://img.shields.io/github/contributors/LauraBeatris/gobarber-web?color=ff9000&style=flat-square)](https://github.com/LauraBeatris/gobarber-web/graphs/contributors)

---

# :pushpin: Table of Contents

* [Features](#rocket-features)
* [UI Documentation](#framed_picture-ui-documentation)
* [Installation](#construction_worker-installation)
* [Getting Started](#runner-getting-started)
* [FAQ](#postbox-faq)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)



# :rocket: Features

* #### Create an account as a service provider or as a costumer.
* #### Schedule and manage appointments

#### Copying the dashboard URL to persist the selected month across multible browser tabs

#### Handling loading when loading the provider month availability

#### Listing notifications and marking them as read

#### Updating user profile

# :framed_picture: UI Documentation
This project has a UI Documentation of reusable components, allowing to test them individually.

[Click there to see the storybook](http://storybook-gobarber.lauradeveloper.com.br/?path=/story/*)

# :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:**

```bash
git clone https://github.com/LauraBeatris/gobarber-web.git
```

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

```bash
git clone [email protected]:LauraBeatris/gobarber-web.git
```

**Install dependencies**

```bash
yarn install
```

Create your enviroment variables based on the examples of `.env.example`

```bash
cp .env.example .env
```

After copying the examples, make sure to fill the variables with new values.

**Setup the API**

The interface needs to interact with the server to receive and register data.

Make sure to go to the [Hotseat API](https://github.com/LauraBeatris/hotseat) repository and follow the instructions in order to get it running in your machine.

# :runner: Getting Started

Run the following command in order to start the application in a development environment:

```bash
yarn start
```

# :postbox: Faq

**Question:** What are the tecnologies used in this project?

**Answer:** The tecnologies used in this project are [React](https://pt-br.reactjs.org/) + [Styled Components](https://styled-components.com/) to handle scoped CSS.

# :bug: Issues

Feel free to **file a new issue** with a respective title and description on the [Go Barber](https://github.com/LauraBeatris/gobarber-web/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/LauraBeatris/gobarber-web/blob/master/CONTRIBUTING.md) to find out about the coding standards.

# :tada: Contributing

Check out the [contributing](https://github.com/LauraBeatris/gobarber-web/blob/master/CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.

# :closed_book: License

Released in 2020 (Work in progress)
This project is under the [MIT license](https://github.com/LauraBeatris/gobarber-web/master/LICENSE).

Made with love by [Laura Beatris](https://github.com/LauraBeatris) 💜🚀