- ProjectManager - API -

Demo 📸

---

Application deploy with Heroku: 💨

https://project-manager-wsl.herokuapp.com/docs/

📖 About the Project

ProjectManager-API - This is a project manager build with Node.js, TypeORM and PostgreSQL.

📗 Features

Feature	Coded?	Description
Create user	✔	Ability to create a user (dev)
Enable user	✔	Ability to enable a user
Login user	✔	Ability to login user
Create client	✔	Ability to create client
List all clients	✔	Ability to list all clients
List client by name	✔	Ability to list client filtered by name
Update client	✔	Ability to update informations about client
List clients with pagination	✔	Ability to see all clients in pagination
Delete client	✔	Ability to delete a client
Send email with code on create client	✔	Ability to send email with code on create client
Client can entry with code and see project data.	✔	Ability to client entry in project
Create project	✔	Ability to create project
List projects	✔	Ability to list all projects
Show project by id	✔	Ability to search project by id
Change project status	✔	Ability to change project status
Upload Logo of Project.	✔	Ability to upload logo of project
List projects of User.	✔	Ability to list projects of user
Delete Project	✔	Ability to delete project by id

🛠 Technologies

Node.js

Typescript

TypeORM

PostgreSQL

Express.js

Multer

JWT

ts-node-dev

Bcryptjs

Swagger

Eslint

Prettier

EditorConfig

💻 How to run the application

Pre-requisites:

You must have the tools installed: Git, Node.js, PotsgreSQL And create a new file called: .env, that follow .env.example credencials.

# In the terminal, clone the project:
$ git clone https://github.com/Wesley-wsl/ProjectManager-api.git

# Enter the project folder:
$ cd ProjectManager-api

# Install dependencies:
$ yarn
or
$ npm install

# Build the application:
$ yarn build
or
$ npm run build

# Run the application:
$ yarn start
or
$ npm run start

Okay, now you can access the application from the route: https://localhost:3333/docs