Skip to content

README.md

Latest commit

 

History

History
89 lines (58 loc) · 1.78 KB

README.md

File metadata and controls

89 lines (58 loc) · 1.78 KB

Professionals Dummy App

This is a RESTful API for a todo application that uses PostgreSQL as a database and Sequelize as an ORM.

Funcionalidades

O Professionals Dummy App oferece um conjunto de funcionalidades essenciais para a administração de equipamentos de uma fábrica, incluindo:

Equipamentos: permite registrar e gerenciar informações sobre equipamentos disponíveis para uso na fabrica.

Tecnologias

  • REST com documentação OpenAPI
  • Hono.js e TypeScript
  • Sequelize com postgres

Getting Started

Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn

Installation

  1. Clone the repository
  2. Install dependencies:
npm install
  1. Set up environment variables:
# Create a .env file with the following content
PORT=3000
  1. The database is automatically initialized when starting the application.

Running the Application

Development mode:

npm run dev

Production mode:

npm run build
npm start

Linting

npm run lint
npm run lint:fix

Documentation

The app swagger documentation is available at the root endpoint (/) when the server is running.

Project Structure

src/
├── application/     # Application services and use cases
├── domain/          # Domain models and interfaces
├── infrastructure/  # External services, database, web server
│   ├── database/    # Database implementation
│   └── web/         # Web server configuration
├── presentation/    # Controllers and DTOs
└── config/          # Application configuration

Endpoints

The Professionals Dummy App provides the following endpoints:

  • /professional - Manage Professionals

License

This project is licensed under the MIT License - see the LICENSE file for details.