-
+
-## Descrição
-Api de uma aplicação de controle de pontos de empresas.
+## Description
-Estrutura de pastas baseada na clean architecture.
+Api of a company points control application.
-Criada a documentação da api utlizando swagger. (Página inicial da aplicação)
+Mass structure based on clean architecture.
-Flowchart do projeto completo: https://whimsical.com/pointcontrol-5dryUV3teiRwy1rPzH3ekK
+Created api documents using swagger (Application homepage).
-### Requerimentos
+Complete project flowchart created on Whimsical.
+## Requirements
+
+* [Npm](https://www.npmjs.com/)
* [Yarn](https://yarnpkg.com/)
-* [SqlServer](https://www.microsoft.com/pt-br/sql-server/sql-server-downloads)
* [Nodejs](https://nodejs.org/en/)
+* [SqlServer](https://www.microsoft.com/pt-br/sql-server/sql-server-downloads)
-### Tecnologias
+## Technologies
* Typescript
* Express
* Nodemon
* TypeORM
-* ESLint
+* Swagger (Documentation)
+* ESLint (Airbnb config)
* Prettier
-* Swagger
-### Instalando Dependencias
+## Usage
+You can clone it on your pc using the command:
```bash
git clone https://github.com/Lissone/pointControl-api.git
cd pointControl-api
+```
+Install dependencies using:
+```bash
yarn
#or
npm run
```
-### Configurações do Banco de dados
-
-É necessário criar o database antes de executar o projeto (dbPointControl), e alterar as variáveis de ambiente, encontradas no arquivo: .env.
+### Database configuration
+You must create the database before running an api (dbPointControl).
```typescript
// .\src\external\database\dbConfig.ts
@@ -76,10 +91,34 @@ const connection = createConnection({
})
```
-### Executar projeto
+Need to add environment variables:
+```bash
+# .\.env
+# DEFAULT
+PORT=5000
+
+# DATABASE
+DB_USERNAME=sa
+DB_PASSWORD=123456
+DB_NAME=dbPointControl
+DB_HOST=localhost
```
+
+Run api:
+```bash
yarn dev
#or
-npm run
+npm run dev
```
+
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
+