/clean-arch-simple-api

Primary LanguageTypeScript

Node.js TypeScript Jest Starter

This repository serves as a basic setup for a Node.js project using TypeScript for type safety and Jest for testing.

Features

  • Node.js: A JavaScript runtime built on Chrome's V8 JavaScript engine for building scalable network applications.
  • TypeScript: A typed superset of JavaScript that compiles to plain JavaScript.
  • Jest: A delightful JavaScript testing framework with a focus on simplicity.

Getting Started

Prerequisites

  • Node.js installed on your machine. You can download it here.
  • This project was built using node 20.12.1 consider check if it fits to your envrioment!
  • npm (Node Package Manager) comes bundled with Node.js installation.

Installation

  1. Clone this repository to your local machine:

    git clone https://github.com/vitorconti/node-ts

  2. Navigate to the project repository

    npm install

  3. For creating production code run

    npm run build

  4. For running the production code

  npm start
  1. For running the tests
  npm test

Project Structure

  • src/: Contains the source code of your application.
  • src/server/index.ts: Entry point of your application.
  • tsconfig.json: TypeScript configuration file.
  • package.json: Metadata about the project and its dependencies.

License

This project is licensed under the MIT License.