README.md

ReactJS Application for PontoLoc project

About the project   |    Technologies   |    Getting started   |    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 this company, from creating customers register to finalizing contracts.

Features

• Manage clients
• Manage materials
• Manage contracts
• Calculate the final price of one contract

To see the api, click here: PontoLoc Rest API

🚀 Technologies

Technologies that I used to develop this web client

• ReactJS
• TypeScript
• React Router DOM
• React Icons
• UnForm 💜
• Yup
• Styled Components
• Polished
• Axios
• Husky
• Commitlint
• Commitizen
• Eslint
• Prettier
• EditorConfig

💻 Getting started

Requirements

• Have this application's API running

Clone the project and access the folder

$ git clone https://github.com/EliasGcf/pontoloc-web.git && cd pontoloc-web

Follow the steps below

# Install the dependencies
$ yarn

# Be sure the file 'src/services/api.ts' have the IP to your API

# Start the client
$ yarn start

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 Elias Gabriel 👋 See my linkedin