brennomeneses/tcc

Kokpit - TCC (Back-end)

This the introduction of our Final Paper Project, here you will find links such like the REST API docs, intructions to build and run, and finally, status of features, parsed by git branches.

REST API Documentation

You can find the full REST API doc in this link.

Instrutions to build:

You must have Node.js at least in 16.04 LTS and NPM 9.1.3 and Yarn (Optional) 1.22.19 Then you can follow this commands:

yarn install # For yarn
npm i # for npm

Then configure the .env file. A file sample can be found in .env.example the app uses this Envoriment Variables (Exemple of .env.example) Do not pull .env file in production:

PORT=3333
HOST=0.0.0.0
NODE_ENV=development
APP_KEY=2YqS-zuClW_mT8P_apy4becgu8g-ah4G
DRIVE_DISK=local
DB_CONNECTION=mssql
MSSQL_SERVER=localhost
MSSQL_PORT=1433
MSSQL_USER=lucid
MSSQL_PASSWORD=
MSSQL_DB_NAME=lucid

Feature status: - Feature was request beyond the func. requirements

- Feature to get started.

- Feature being developed, soon in repository.

- Feature done and in repository.

- Feature tested and runing in production.

Feature	Status	Branch
Create company		main
Get all companies		main
Create a user		main
Login as User		main
Get all users		main
Create a project		main
Get all projects		main
Assosiate somebody to a project
Create tasks
Companie's banner image