Skip to content

Latest commit

 

History

History
162 lines (129 loc) · 3.79 KB

README.md

File metadata and controls

162 lines (129 loc) · 3.79 KB

Project Manager

Project Manager System is an application designed to assist in project production and proficiency, helping you achieve your objectives efficiently.

API Documentation


Project Manager API developed with Swagger
Swagger is an application that has many tools for developers, and one of the tools is that you can create API documentation

Table of Contents

Relationships

Relationships - Project Manager

Download Relationships Diagram

Requirements

Clarifying the project requirements is crucial for quality and accuracy in development.

Download Project Requirements

Entities

User

  • ID (unique)
  • Name
  • Email
  • Password (hash)
  • Creation Date

Project

  • ID (unique)
  • Name
  • Description
  • Creation Date
  • User ID (relationship with the User entity)

Task

  • ID (unique)
  • Title
  • Description
  • Creation date
  • Completion date (optional)
  • Status (pending, in progress, completed)
  • Project ID (relationship with the Project entity)

Technologies Used

  • Node.js
  • Express.js
  • JWT (JSON Web Token)
  • MySQL
  • Sequelize
  • Bcrypt
  • MVC Pattern
  • CORS
  • Nodemon (dev dependency)

Project Structure

project-manager/
├── src/
│ ├── api/
│ │ ├── project.js
│ │ ├── task.js
│ │ └── user.js
│ ├── controllers/
│ │ ├── project.js
│ │ ├── task.js
│ │ └── user.js
│ ├── models/
│ │ ├── project.js
│ │ ├── task.js
│ │ └── user.js
│ ├── routes/
│ │ ├── project.js
│ │ ├── task.js
│ │ └── user.js
│ ├── middlewares/
│ │ └── authMiddleware.js
│ ├── config/
│ │ └── database.js
│ ├── app.js
│ └── server.js
├── package.json
└── README.md

Setup and Installation

Prerequisites

  • Node.js installed
  • MySQL installed and running

Steps

  1. Clone the repository

    git clone https://github.com/matheusmartinsviana/project-manager.git
cd project-manager

  2. Install dependencies

    npm install

  3. Configure the database

    Create a MySQL(But to deploy in rendering I needed to use PostgreSQL) database with the following details:

    database: 'project-manager'
host: 'localhost'
username: 'root'
dialect: 'mysql'

  4. Run the development server

    npm run dev

Integration and API Tests

To see all tests you need change this branch to: bash Branch: tests

Tests Structure

project-manager/
├── src/
│ ├── ...
│ ├── tests/
│ │ ├── api/
│ │ | ├──project.js
│ │ | ├── task.js
│ │ | └── user.js
│ │ ├── integration/
│ │ | ├──project.js
│ │ | ├── task.js
│ │ | └── user.js

Technologies Used

  • Jest (dev dependency)
  • Supertest (dev dependency)