Efficiency

This is a personal project that aims to develop a multiplatform webapp to serve as a dashboard, where a retail store's manager or supervisor can watch over his sellers' performance.

This project is currently in development using Angular 14, ASP.NET CORE 6 and MySQL.

🪧 Vitrine.Dev
✨ Nome	Efficiency
🏷️ Front-End	Angular 14, Typescript, Bootstrap, CSS
🏷️ Back-End	ASP.NET Core 6, C#, MySQL
🚀 API	http://localhost:5280 follow instructions bellow
🚀 Front-End	http://localhost:4200 follow instructions bellow

Screenshots

Original Design

The original design of this tool was made using Figma to wireframe everything and the font combination was made with FontJoy

Take a look at the design project Here

Installing prerequisites

Install Node.JS 16.19.0

  https://nodejs.org/download/release/v16.19.0/

Install .Net 6 LTS SDK

  https://dotnet.microsoft.com/en-us/download

Install Git Bash

  https://git-scm.com/downloads

Install MySQL

  https://dev.mysql.com/downloads/mysql/

Suggestion Install Microsoft's Visual Studio Code

  https://code.visualstudio.com/

Running the front-end locally

Clone project

  git clone https://github.com/MarceloCFerraz/Efficiency.git

Enter on the project's directory

  cd Efficiency/front-end/

Install dependencies

  npm i

Build

  ng build

Run server

  ng serve -o

Running the API locally

Clone project (if you haven't already)

  git clone https://github.com/MarceloCFerraz/Efficiency.git

Enter on the project's directory

  cd Efficiency/back-end/

Install Entity Framework tool to your .net installation

  dotnet tool install --global dotnet-ef

Create the database

  dotnet ef database update

Build

  dotnet build

Start the API server

  dotnet run

Access the API through Swagger

  http://localhost:5280/swagger/index.html

Or access it via other tool of your liking such as:

• Postman
• Insomnia

API Documentation

User

Get All

  GET /user

Parameter	Type	Description
``	``	It recieves no arguments (for now)

Get one user

  GET /user/${ID}

Parameter	Type	Description
ID	int	Mandatory. The user's identification key

Sign user in

  POST /login

Parameter	Type	Descrição
request	LoginRequest	Mandatory. User's login request object (for now) from the body of the request containing the user's e-mail and password

Sign user up

  POST /signup

Parameter	Type	Description
userDTO	PostUserDTO	Mandatory. User's POST data transfer object (for now) from the body of the request containing the user's e-mail, password, first and last names, username, role, phone number and the Store's ID reference

Update user information

  PUT /user

Parameter	Type	Description
userDTO	PutUserDTO	Mandatory. User's PUT data transfer object from the body of the request containing the user's ID, e-mail, password, first and last names, role, phone number and the Store's ID reference

Delete user

  PUT /user/${ID}

Parameter	Type	Description
ID	int	Mandatory. User's identification key