My Template Repository

My template repository for projects

Status: In progress | Finished

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

About

My Template Repository - 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 Draw.io:

Mobile

Web

---

How it works

This project is divided into three parts:

1. Backend folder (src { API { Controller, Infra } , Worker , Migration }, test { Unit , Integration } )
2. Frontend folder (src, public, tests)
3. Mobile folder (src, tests)

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/proj-007-my-template-repository.git

# Access the project folder cmd/terminal
cd backend/src/MyTemplateRepository.API

# 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/proj-007-my-template-repository.git

# Access the project folder in your terminal
cd frontend

# Install the dependencies
yarn install

# Run the application in development mode
yarn 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)

• Create React App
• React Router Dom
• Chakra UI
• React Icons - Heroicons 2
• ESLint (dev)
• Prettier (dev/with eslint)

See the file package.json

Server (.NET + C#)

• ASP.NET
• SQLite
• DocFX
• reportgenerator

See the file api.csproj

Mobile (React Native + TypeScript)

• React Native Elements
• React Navigation
• React Native Save Area
• React Native Vector Icons
• React Native Device Info
• Axios
• Expo

See the file package.json

Utilities

• Prototype: Draw.io → MyTemplateRepository

• Editor: Visual Studio Code → Extensions: ESLint, EditorConfig

• Dependency: Yarn → doc package.json

• Build: esbuild → Tip: Post

• API Test: Postman

• Multiple Version Node: NVM

• Commit Conventional: Commitlint

• API: IBGE API → API States, API Counties

• Markdown: StackEdit, Markdown Emoji

• Fonts: Ubuntu, Roboto

---

Author

_{Ederson Fernandes}