nodejs-appbuilder

NodeJS APP Builder

🚧 🚀 In Production 🚧

Sumário

• Sumário
• Project
  • Pre-requisites
    • 🎲 Running the Project
• Architecture
  • Main Libs
• Scrits
• Functionalities
  • For Examples, verify the TESTS
• Autores

---

Project

Create NodeJS applications with a Serverless handler, easily add routes.

Pre-requisites

Before you start, install it on your machine: Git, Node.js. Some code editor like VSCode

🎲 Running the Project

# Clone the repository
$ git clone <https://github.com/celio1878/nodejs_appbuilder>

# Access the projeto in the terminal/cmd
$ cd nodejs_appbuilder

# Go to codes directory
$ cd code

# Install the dependencies
$ npm install

# Exec the tests
$ npm test

# Verify the test coverage
$ npm run test:coverage

---

Architecture

Layered architecture with TDD.

Coverage all functionalities in the tests.

Main Libs

• Express
• Typescript
• CORS
• Compression
• TS-PRUNE

Scrits

npm test: Exec all tests of project
npm run test:watch: Exec all tests of project and watch for changes
test:coverage: Exec all tests of project and generate a coverage report
build: Build the project,
prepare: Prepare the project for production,
find-deadcode: Find dead code in the project,

---

Functionalities

• [x] Create API
• [x] Create a new route
• [x] Test Coverage
• [x] Remove unused code
• [x] Build

For Examples, verify the TESTS

---

Autores

Célio Vieira

Ricardo Onodera