Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/douglasvolcato/node-tdd-clean-architecture

Clean architecture project made with TypeScript and TDD using Jest
https://github.com/douglasvolcato/node-tdd-clean-architecture

bcrypt clean-architecture clean-code design-patterns jest jest-tests node nodejs object-oriented-programming tdd test-driven-development typescript

Last synced: about 1 month ago
JSON representation

Clean architecture project made with TypeScript and TDD using Jest

Awesome Lists containing this project

README

        

- [How to run this project](#how-to-run)
- [Using Locally](#using-locally)
- [Using Docker](#using-docker)
- [Author](#author)

## How to run this project

To use this project, first download it to your machine and create a .env file with variables according to the .env.example file. Once you've done that, it can be used either on a local server or with the help of Docker.

##

  • Using Locally

    If you choose to use it on a local server, you will need to install the project's dependencies with the following command:

    ```bash
    $ npm install
    ```

    After that, the project will be ready to run using one of the following commands:

    ```bash
    $ npm run start
    ```

    ##

  • Using Docker

    To do this, first make sure you have [Docker](https://www.docker.com) properly installed on your machine. Then use the following commands in sequence:

    ```shell
    $ docker build -t clean-architecture .

    $ docker run -p : --env-file .env clean-architecture
    ```

    ## Author

    - Douglas