{"id":18816044,"url":"https://github.com/0-vortex/pedantic","last_synced_at":"2025-08-18T11:06:37.726Z","repository":{"id":151933448,"uuid":"398599633","full_name":"0-vortex/pedantic","owner":"0-vortex","description":"overmind, overupdates","archived":false,"fork":false,"pushed_at":"2021-08-24T15:39:01.000Z","size":273,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-22T06:11:34.209Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/0-vortex.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":"2021-08-21T16:00:39.000Z","updated_at":"2021-08-27T21:34:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"fd527ca6-ce10-4992-b51f-9d58408f4ed9","html_url":"https://github.com/0-vortex/pedantic","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/0-vortex/pedantic","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0-vortex%2Fpedantic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0-vortex%2Fpedantic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0-vortex%2Fpedantic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0-vortex%2Fpedantic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0-vortex","download_url":"https://codeload.github.com/0-vortex/pedantic/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0-vortex%2Fpedantic/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270982194,"owners_count":24679447,"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-08-18T02:00:08.743Z","response_time":89,"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-07T23:52:03.238Z","updated_at":"2025-08-18T11:06:37.702Z","avatar_url":"https://github.com/0-vortex.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pedantic\n\n[![Release](https://github.com/0-vortex/pedantic/actions/workflows/release.yml/badge.svg)](https://github.com/0-vortex/pedantic/actions/workflows/release.yml)\n [![Release](https://github.com/0-vortex/pedantic/actions/workflows/development.yml/badge.svg)](https://github.com/0-vortex/pedantic/actions/workflows/development.yml)\n [![Release](https://github.com/0-vortex/pedantic/actions/workflows/compliance.yml/badge.svg)](https://github.com/0-vortex/pedantic/actions/workflows/compliance.yml)\n [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n\n- [Overview](#overview)\n- [Requirements](#requirements)\n- [Folder structure](#folder-structure)\n- [Installation](#installation)\n- [Application requirements](#application-requirements)\n- [How to use](#how-to-use)\n- [Infrastructure](#infrastructure)\n- [Contributing](#contributing)\n\n## Overview\n\nWIP\n\n## Requirements\n\nIn order to run the project from a container we need `node\u003e=15`, `npm\u003e=7` and `docker\u003e=20` installed on our development machines.\n\n## Folder structure\n\nA quick look at the top-level files and directories you'll see in a Gatsby project.\n\n```\n├──── pedantic\n│  ├── .github/\n│  ├── .husky/\n│  ├── src/\n│  ├── .dockerignore\n│  ├── .editorconfig\n│  ├── .eslintrc.js\n│  ├── .gitattributes\n│  ├── .gitignore\n│  ├── .lintstagedrc.js\n│  ├── .npmrc\n│  ├── compose.yaml\n│  ├── Dockerfile\n│  ├── nest-cli.json\n│  ├── npm-shrinkwrap.json\n│  ├── package.json\n│  ├── README.md\n│  ├── release.config.js\n│  ├── tsconfig.build.json\n│  └── tsconfig.json\n```\n\n## Installation\n\nClone the package via `git`:\n\n```shell\ngit clone git@github.com:0-vortex/pedantic.git\n```\n\nGo into the cloned repository and install `node` dependencies:\n\n```shell\nnpm ci\n```\n\n## Application requirements\n\nThis repository is featuring granular controls fully orthogonal to environment variables as specified by [the twelve-factor app](https://12factor.net) guidelines.\n\nIn order for the application to run we need the following environment variables set similar to the following example.\nWithout these variables the application will fail to start, so in order for the app to start locally we need to create an `.env` file with the following values:\n\n```shell script\n# Global env\nDEBUG=*\nHOST=0.0.0.0\nPORT=3000\n\n# Database ORM configuration\nTYPEORM_CONNECTION=postgres\nTYPEORM_HOST=localhost\nTYPEORM_PORT=5432\nTYPEORM_USERNAME=pedantic-crawler\nTYPEORM_PASSWORD=FJK3zrH2WGxKck7tT2JG4MY6wbHkeX9s\nTYPEORM_DATABASE=pedantic-dev\nTYPEORM_SYNCHRONIZE=false\n\n```\n\n## How to use\n\nTo develop locally just run:\n\n```shell\nnpm start\n```\n\n## Infrastructure\n\nIn order for our project to work it needs the infrastructure to be up. Once ``docker`` is running all we need to do is:\n\n```bash\nnpm run docker:up\n```\n\nYou can then visit [127.0.0.1:3000](http://localhost:3000) to interact with the running sessions.\n\nThere are additional ``docker`` commands built into our default script usage.\n\nOne is to stop the current ``docker`` container without wiping data:\n\n```bash\nnpm run docker:down\n```\n\nOne is to remove the current ``docker`` container while wiping data:\n\n```bash\nnpm run docker:destroy\n```\n\n## Contributing\n\nThis repository uses `husky` with pre-commit and message hooks. All you need to do after staging some files is to run:\n\n```shell\nnpm run push\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0-vortex%2Fpedantic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0-vortex%2Fpedantic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0-vortex%2Fpedantic/lists"}