README.md

CleanArqWebUI

My base repository for projects

Status: Finished

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

About

CleanArqWebUI - description about the project

---

Features

• Feature One:

  • description of task
  • description of task
  • description of task
  • description of task:
    • topic 1
    • topic 2
    • topic 3

• Feature Two:

  • description of task
  • description of task
  • description of task

---

Layout

The application layout is available on Figma:

Mobile

Web

---

How it works

This project is divided into three parts:

1. Backend (server folder)
2. Frontend (web folder)
3. Mobile (mobile folder)

Both Frontend and Mobile 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, Node.js, .NET SDK.

In addition, it is good to have an editor to work with the code like VSCode

Running the Backend (Server)

# Clone this repository
$ git clone git@github.com:efernandes-tech/dotnet-006-udm-clean-arq-web-ui.git

# Access the project folder cmd/terminal
$ cd CleanArqMvc

# go to the server folder
$ cd server

# install the dependencies
$ dotnet build

# Run the application in development mode
$ dotnet run

# The server will start at port: 5000 - go to http://localhost:5000

Running the Frontend (Web)

# Clone this repository
$ git clone git@github.com:efernandes-tech/dotnet-006-udm-clean-arq-web-ui.git

# Access the project folder in your terminal
$ cd CleanArqMvc

# Go to the Front End application folder
$ cd web

# Install the dependencies
$ npm install

# Run the application in development mode
$ npm run start

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

---

Tech Stack

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

Web (React + TypeScript)

• React Router Dom
• React Icons
• Axios
• Leaflet
• React Leaflet
• React Dropzone

See the file package.json

Server (.NET + C#)

• ASP.NET
• SQLite

See the file api.csproj

Mobile (React Native + TypeScript)

• Expo
• Expo Google Fonts
• React Navigation
• React Native Maps
• Expo Constants
• React Native SVG
• Axios
• Expo Location
• Expo Mail Composer

See the file package.json

Utilities

• Prototype: Figma → Prototype (CleanArqWebUI)
• API: IBGE API → API States, API Counties
• Maps: Leaflet
• Editor: Visual Studio Code → Extensions: SQLite
• Markdown: StackEdit, Markdown Emoji
• Commit Conventional: Commitlint
• API Test: Insomnia
• Icons: Feather Icons, Font Awesome
• Fonts: Ubuntu, Roboto

---

Contributors

A big thanks to this group that made this product leave the field of idea and enter the app stores :)

You are an awesome team! :)

Ederson Fernandes 🌐	Ederson Fernandes 🌐	Ederson Fernandes 🌐
Ederson Fernandes 🌐	Ederson Fernandes 🌐	Ederson Fernandes 🌐

How to contribute

1. Fork the project.
2. Create a new branch with your changes: git checkout -b my-feature
3. Save your changes and create a commit message telling you what you did: git commit -m "feat: my new feature"
4. Submit your changes: git push origin my-feature

If you have any questions check this guide on how to contribute

---

Author

_{Ederson Fernandes}
🌐

---

License

This project is under the license MIT.

Made with love by Ederson Fernandes 👋🏽 Get in Touch!

---

Versions of README

English | Portuguese