{"id":13598428,"url":"https://github.com/mentos1386/lynx","last_synced_at":"2025-04-10T09:31:14.844Z","repository":{"id":90452269,"uuid":"121665305","full_name":"mentos1386/lynx","owner":"mentos1386","description":"Opinionated Framework built on top of NestJS and TypeORM","archived":true,"fork":false,"pushed_at":"2019-03-26T20:34:46.000Z","size":154,"stargazers_count":44,"open_issues_count":7,"forks_count":5,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-11-06T23:37:54.897Z","etag":null,"topics":["nestjs","typeorm","typescript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mentos1386.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2018-02-15T18:25:44.000Z","updated_at":"2023-01-28T15:11:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"109f54b1-fd49-4d25-82d7-a0440fe6ad9d","html_url":"https://github.com/mentos1386/lynx","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mentos1386%2Flynx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mentos1386%2Flynx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mentos1386%2Flynx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mentos1386%2Flynx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mentos1386","download_url":"https://codeload.github.com/mentos1386/lynx/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248191690,"owners_count":21062552,"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","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":["nestjs","typeorm","typescript"],"created_at":"2024-08-01T17:00:52.514Z","updated_at":"2025-04-10T09:31:09.827Z","avatar_url":"https://github.com/mentos1386.png","language":"TypeScript","funding_links":[],"categories":["Resources","资源"],"sub_categories":[],"readme":"# Lynx Framework\n\u003e **ABANDONED PROJECT** Sadly i don't have enough time to focus on this project. Might return to it sometime in the future.\n\n\u003e For now, it can be taken as a referance, but not an actual framework.\n\n## Built with\n_**Bold** are required components (not easy to replace)_\n\n Component |                      Using                      | Descrption\n---------- | ----------------------------------------------- | ----------\n**Base**   | [NestJS](https://nestjs.com)                    |\n**Database**| [TypeORM](http://typeorm.io/)                   |\n**File Upload**| [Multer](https://github.com/expressjs/multer)   |\nLogger     | [Winston](https://github.com/winstonjs/winston) |\nError Reporting| [Sentry](https://sentry.io/welcome/)        |\nValidation | [Class-Validator](https://github.com/typestack/class-validator)|\nDocumentation| [Swagger](https://swagger.io)                 |\nConfiguration| [Dotenv](https://github.com/motdotla/dotenv)  |\nAuthentication| [Passport.js](http://www.passportjs.org)     |\nTesting    | [Mocha](https://mochajs.org) \u0026 [Chai](http://chaijs.com)|\nCode Style | [Airbnb](https://github.com/airbnb/javascript) \u0026 [TS-Lint](https://palantir.github.io/tslint/)|\n\n## Progress\n\n - [x] File Upload (disk, s3, memory)\n - [ ] Authentication (JWT, OAuth)\n - [x] Logger\n - [ ] Request Context\n - [ ] Error Reporting\n - [ ] Database Migrations\n - [ ] Database Seeding\n - [ ] Testing (e2e, unit)\n\n## Usage\n\n### Install\n```\n$ npm install\n```\nCreate new file `.env` in project root folder using `example.env` as a template. \n\n### Start\n\nDevelopment environment:\n```\n$ npm run start\n```\n\nProduction environment:\n```\n$ npm run build\n$ node dist/src/api.ts\n```\n\n### Initial database creation\n```\n$ npm run migrate sync\n```\n\n### Migrations\nCreating new migration named `createSomeModel`:\n```\n$ npm run migrate create createSomeModel\n```\nOther commands are self-explanatory:\n```\n$ npm run migrate [up|down|executed|pending|create]\n```\n\n### E2E Testing\nFirst run the testing server:\n```\n$ npm run start:test\n```\nThen run Mocha testing framework:\n```\n$ mocha test/*.spec.ts\n```\nBefore hooks in `e2e/` directory will clean test database, initialize sequelize and seed fake data.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmentos1386%2Flynx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmentos1386%2Flynx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmentos1386%2Flynx/lists"}