/gobarber-web

A React application to help barbers check daily clients booking!

Primary LanguageJavaScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

GoBarber

Frontend module
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

Sign In

GoBarber


Sign Up

GoBarber


Dashboard

GoBarber


Notifications

GoBarber


Profile

GoBarber


This application was built during Rocketseat's bootcamp to learn the usage of React Redux + Sagas + Hooks and it is also the frontend module of the backend service built in past modules. The frontend application allows a barber to:

  • Create an account in the service;
  • Check daily clients appointments: A dashboard shows the booked clients highlighted in yellow;
  • Get notifications when new appointments are made;
  • Edit profile informations: Allows to update its profile picture, email, name, password.

Another features:

  • JWT authentication.

PS.: You may ask: where is the client module? It will be developed in the future.

Built With

Main libraries and CLI tools used to built the project:

To manage the code style and formatting:

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

Install NodeJS:

Install a package manager:

  • yarn: Yarn 1.x (classic) was used in this project.

or

  • npm

    npm install npm@latest -g

  • Setup and execute GoBarber backend, disponible here.

Installation

  1. Clone the repository:

    Using ssh:
git clone git@github.com:dzvid/gobarber-web.git

Or using https:
git clone https://github.com/dzvid/gobarber-web.git

  2. Install the project dependencies:

    cd gobarber-web

yarn

    or using npm:

    cd gobarber-web

npm install

  3. Create the .env file, use the .env.example as template, it has a REACT_APP_BASE_URL variable that receives the API address for the production build.

  4. Make sure the backend service is running.

  5. Open a terminal window and start the development server:

    yarn start

    You can now view GoBarber web module in the browser at: http://localhost:3000/

  6. You are done with configuration and ready to code! (I hope so 🎉).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

David Oliveira - oliveiradavid.dev@gmail.com

Project Link: https://github.com/dzvid/gobarber-web

Acknowledgements