Cotatus

We help you build your project in React!

Status: develop

About • Features • How it works • Tech Stack • Author • License

About

PROJECT - Is a way to help build a new project in React using a folder structure and pre-assembled and customized components.

---

Features

• Users will be able to access via token
• Packages can be registered on the web platform by sending:
  • title
  • description

---

How it works

The project is divided into two parts:

1. Backend (another repo)
2. Frontend (this repo)

But this repository is referring only to the Frontend part. Frontend need the Backend to be running to work.

Pre-requisites

Before you begin, you will need to have the following tools installed on your machine: [Git] (https://git-scm.com), [Node.js] (https://nodejs.org/en/). In addition, it is good to have an editor to work with the code like [VSCode] (https://code.visualstudio.com/)

Running the web application (Frontend)

# Clone this repository
$ git clone https://github.com/Cotatus/FE.git

# Access the project folder in your terminal
$ cd FE

# Install the dependencies
$ npm

# Run the application in development mode
$ npm run dev

# The application will open on the port: 3000 - go to http://localhost:5173

---

Tech Stack

The following tools were used in the construction of the project:

Platform (React + TypeScript)

• React Router Dom
• React Icons
• Axios
• Leaflet
• React Leaflet
• React Redux
• AntDesign
• react-device-detect
• moment.js
• Bootstrap
• sass
• Styled Components

See the file package.json

Utils

• API: IBGE API → API de UFs, API de Municípios
• Maps: Leaflet
• Editor: Visual Studio Code
• Icons: Feather Icons, Font Awesome
• Fonts: Ubuntu, Roboto

---

Author

Evelin Steiger

---

License

This project is under the license MIT.

Made with love by Evelin Steiger 👋🏽 Get in Touch!

---

Learn More

This project was created and bootstrapped with Create React App.

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.