felipeDS91 / goldman-frontend

💍 Web platform of goldman application - made with reactjs, styled-components and unForm

ReactJS Application for Goldman project

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

👨🏻‍💻 About the project

This is a ReactJS web client that will be used by the company manager!

With this web client, it's possible to control the entire flow of order's company, from creating customers register to finalizing orders.

Features

• Manage customers
• Manage orders
• Profit visualization
• Calculate the final price of orders

To see the api, click here: Goldman Rest API

🚀 Technologies

Technologies that I used to develop this web client

• ReactJS
• React Router DOM
• Redux
• Redux-Saga
• Prop-Types
• React Icons
• UnForm 💜
• Yup
• Styled Components
• Polished
• Axios
• Eslint
• Prettier
• EditorConfig

💻 Getting started

Requirements

• Have this application's API running

Clone the project and access the folder

$ git clone https://github.com/felipeDS91/goldman-frontend.git && cd goldman-frontend

Follow the steps below

# Install the dependencies
$ yarn

# Copy and rename file '.env.example' to '.env' and fill out the constant "REACT_APP_API_URL" with your IP address

# Start the client
$ yarn start

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork felipeDS91/goldman-frontend

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd goldman-frontend

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with 💜  by Felipe Douglas 👋 See my linkedin