{"id":20032606,"url":"https://github.com/vagnercardosoweb/nodejs-structure-with-typescript","last_synced_at":"2025-09-01T03:08:41.901Z","repository":{"id":172899146,"uuid":"482198033","full_name":"vagnercardosoweb/nodejs-structure-with-typescript","owner":"vagnercardosoweb","description":"Structure already configured to start any API in NODE with Typescript","archived":false,"fork":false,"pushed_at":"2024-01-14T04:32:08.000Z","size":1784,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-02T05:41:16.042Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vagnercardosoweb.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-16T08:24:52.000Z","updated_at":"2023-11-11T05:18:13.000Z","dependencies_parsed_at":"2023-11-26T05:22:40.353Z","dependency_job_id":"38469f5c-0e2e-45ea-aae2-1b9584734617","html_url":"https://github.com/vagnercardosoweb/nodejs-structure-with-typescript","commit_stats":null,"previous_names":["vagnercardosoweb/typescript-with-jest","vagnercardosoweb/nodejs-structure-with-typescript"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vagnercardosoweb/nodejs-structure-with-typescript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vagnercardosoweb%2Fnodejs-structure-with-typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vagnercardosoweb%2Fnodejs-structure-with-typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vagnercardosoweb%2Fnodejs-structure-with-typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vagnercardosoweb%2Fnodejs-structure-with-typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vagnercardosoweb","download_url":"https://codeload.github.com/vagnercardosoweb/nodejs-structure-with-typescript/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vagnercardosoweb%2Fnodejs-structure-with-typescript/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273068856,"owners_count":25039911,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-01T02:00:09.058Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T09:38:26.952Z","updated_at":"2025-09-01T03:08:41.881Z","avatar_url":"https://github.com/vagnercardosoweb.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Technologies Used\n\n- NodeJs [https://nodejs.org/en/](https://nodejs.org/en/)\n- Typescript [https://www.typescriptlang.org/](https://www.typescriptlang.org/)\n- Express [https://github.com/expressjs/express](https://github.com/expressjs/express)\n- Docker and Docker-Compose [https://www.docker.com/](https://www.docker.com/)\n  - Postgresql [https://www.postgresql.org/](https://www.postgresql.org/)\n  - Redis [https://redis.io/](https://redis.io/)\n- and other auxiliaries...\n\n## Run Project\n\nIt is necessary to have docker and docker-compose installed on your machine, and for that you just\naccess\nthe [official documentation](https://docs.docker.com/engine/install/) for installation and select\nyour operating system,\nafter that just run the commands below.\n\n- Clone the\n  repository `git clone git@github.com:vagnercardosoweb/nodejs-structure-with-typescript.git -b main`\n- Access the folder `cd nodejs-structure-with-typescript`\n- Copy `.env.example` to `.env.local` and change the values according to your needs.\n- Create Db Volume `docker volume create --name=app-postgres`\n- Run server with docker `npm run dev:docker`\n\nThe port `3000` is based on `env.DOCKER_PORT`, by default it is `3000`,\nif you want to change it, just change the value of the environment variable.\n\nafter step up your server will be online on\nhost [http://localhost:3000](http://localhost:3000)\n\n## Run migrations\n\nBefore the steps below, you must generate the `build` with the `npm run build` command if it is not\na `production` build.\n\nIf the environment variable `DB_MIGRATION_ON_STARTED` is set to `true` as\nmigrations will be automatically executed when starting the server, otherwise you can\nrun manually with the command `NODE_ENV={value} npm run db:migration:up`.\n\nThe value of `{value}` must be the name of the `env` file configured based on `.env.{value}`,\nIf the variables are already configured for the environment, just run the\n`npm run db:migration:up` command.\n\nTo rollback migrations, simply run the command `npm run db:migration:down:last` to\nundo the last operation, or `npm run db:migration:down:all` to undo all operations.\n\n## Run unit tests\n\n- `npm run test:unit:all` to run all tests once\n- `npm run test:unit:coverage` to run all tests and generate test coverage report\n- `npm run test:unit:watch` to run all tests and watch for changes to files\n\n## Run integration tests\n\n- `npm run test:e2e:all` to run all tests once\n- `npm run test:e2e:coverage` to run all tests and generate test coverage report\n- `npm run test:e2e:watch` to run all tests and watch for changes to files\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvagnercardosoweb%2Fnodejs-structure-with-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvagnercardosoweb%2Fnodejs-structure-with-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvagnercardosoweb%2Fnodejs-structure-with-typescript/lists"}