{"id":20605092,"url":"https://github.com/ferrymehdi/ts-setup","last_synced_at":"2025-03-06T16:54:27.615Z","repository":{"id":245890948,"uuid":"819480599","full_name":"ferrymehdi/ts-setup","owner":"ferrymehdi","description":"This project is a basic setup for developing a Node.js application using TypeScript, ts-node, and nodemon for automatic restarts during development.","archived":false,"fork":false,"pushed_at":"2024-06-24T15:41:26.000Z","size":15,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-17T02:24:07.135Z","etag":null,"topics":["nodejs","nodets","setup","ts"],"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/ferrymehdi.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":"2024-06-24T15:32:57.000Z","updated_at":"2024-11-18T16:21:00.000Z","dependencies_parsed_at":"2024-06-24T17:34:00.956Z","dependency_job_id":"50ca20f9-9c1e-4fe3-98aa-8a77714d03f4","html_url":"https://github.com/ferrymehdi/ts-setup","commit_stats":null,"previous_names":["ferrymehdi/ts-setup"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ferrymehdi%2Fts-setup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ferrymehdi%2Fts-setup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ferrymehdi%2Fts-setup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ferrymehdi%2Fts-setup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ferrymehdi","download_url":"https://codeload.github.com/ferrymehdi/ts-setup/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242250932,"owners_count":20096895,"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":["nodejs","nodets","setup","ts"],"created_at":"2024-11-16T09:26:29.099Z","updated_at":"2025-03-06T16:54:27.593Z","avatar_url":"https://github.com/ferrymehdi.png","language":"TypeScript","readme":"# TypeScript Project Setup\n\nThis project is a basic setup for developing a Node.js application using TypeScript, ts-node, and nodemon for automatic restarts during development.\n\n## Getting Started\n\n### Prerequisites\n\nEnsure you have Node.js installed. You can download it from [nodejs.org](https://nodejs.org/).\n\n### Installation\n\n1. **Clone the repository:**\n   ```bash\n   git clone https://github.com/ferrymehdi/ts-setup.git\n   cd ts-setup\n   ```\n\n2. **Install the dependencies:**\n   ```bash\n   npm install\n   ```\n\n### Project Structure\n\n```\nts-setup/\n├── src/\n│   └── index.ts\n├── .gitignore\n├── nodemon.json\n├── package.json\n├── tsconfig.json\n└── README.md\n```\n\n### Configuration Files\n\n- **`tsconfig.json`**: TypeScript configuration file.\n- **`nodemon.json`**: Nodemon configuration file.\n\n### Available Scripts\n\n- **`npm run build`**: Compiles TypeScript files to JavaScript.\n- **`npm run dev`**: Runs the project in development mode with nodemon and ts-node.\n- **`npm start`**: Runs the project directly using ts-node.\n\n### Running the Project\n\n1. **Development Mode:**\n   ```bash\n   npm run dev\n   ```\n\n   This will start the project with nodemon, which will watch for changes in the `src` directory and automatically restart the server.\n\n2. **Production Mode:**\n   ```bash\n   npm run build\n   npm start\n   ```\n\n   This will compile the TypeScript files into the `dist` directory and run the compiled JavaScript files.\n\n### Example Code\n\nYou can find the example TypeScript code in `src/index.ts`:\n\n```typescript\nconst sayHello = (name: string): string =\u003e {\n  return `Hello, ${name}!`;\n};\n\nconsole.log(sayHello(\"World\"));\n```\n\n### License\n\nThis project is licensed under the ISC License.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fferrymehdi%2Fts-setup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fferrymehdi%2Fts-setup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fferrymehdi%2Fts-setup/lists"}