{"id":13800062,"url":"https://github.com/IBM-Swift/generator-swiftserver","last_synced_at":"2025-05-13T08:32:42.984Z","repository":{"id":57248990,"uuid":"72868926","full_name":"IBM-Swift/generator-swiftserver","owner":"IBM-Swift","description":"WARNING: This repository is no longer maintained","archived":true,"fork":false,"pushed_at":"2020-02-27T20:50:25.000Z","size":3295,"stargazers_count":63,"open_issues_count":0,"forks_count":21,"subscribers_count":17,"default_branch":"develop","last_synced_at":"2024-11-14T13:38:47.657Z","etag":null,"topics":["api","generator","generator-swiftserver","kitura","rest","server","swift","yeoman"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IBM-Swift.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-04T17:12:03.000Z","updated_at":"2023-05-12T16:45:31.000Z","dependencies_parsed_at":"2022-08-24T16:22:26.544Z","dependency_job_id":null,"html_url":"https://github.com/IBM-Swift/generator-swiftserver","commit_stats":null,"previous_names":[],"tags_count":88,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IBM-Swift%2Fgenerator-swiftserver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IBM-Swift%2Fgenerator-swiftserver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IBM-Swift%2Fgenerator-swiftserver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IBM-Swift%2Fgenerator-swiftserver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IBM-Swift","download_url":"https://codeload.github.com/IBM-Swift/generator-swiftserver/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225190773,"owners_count":17435488,"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":["api","generator","generator-swiftserver","kitura","rest","server","swift","yeoman"],"created_at":"2024-08-04T00:01:08.850Z","updated_at":"2024-11-18T14:31:32.793Z","avatar_url":"https://github.com/IBM-Swift.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Platform"],"sub_categories":[],"readme":"# WARNING: This repository is no longer maintained :warning:\n\n\u003e The generated content is now available in our [Swift static application](https://github.com/IBM/swift-kitura-app).\n\n\u003e This repository will not be updated. The repository will be kept available in read-only mode.\n\n\n# generator-swiftserver\n\n[![Build Status](https://travis-ci.org/IBM-Swift/generator-swiftserver.svg?branch=master)](https://travis-ci.org/IBM-Swift/generator-swiftserver)\n[![codecov](https://codecov.io/gh/IBM-Swift/generator-swiftserver/branch/master/graph/badge.svg)](https://codecov.io/gh/IBM-Swift/generator-swiftserver)\n[![Version](https://img.shields.io/npm/v/generator-swiftserver.svg)][url-npm]\n[![DownloadsMonthly](https://img.shields.io/npm/dm/generator-swiftserver.svg)][url-npm]\n[![DownloadsTotal](https://img.shields.io/npm/dt/generator-swiftserver.svg)][url-npm]\n[![License](https://img.shields.io/npm/l/generator-swiftserver.svg)][url-npm]\n[![Greenkeeper badge](https://badges.greenkeeper.io/IBM-Swift/generator-swiftserver.svg)](https://greenkeeper.io/)\n\n[url-npm]: https://www.npmjs.com/package/generator-swiftserver\n\nThis module is a [Yeoman](http://yeoman.io) generator for creating REST webservices based on the [Kitura web framework](http://kitura.io) with the [Swift](https://swift.org/) language.\n\nThis generator and the Yeoman library runs on Node.js and generates a Swift 5.0 application.\n\n## Contents\n1. [Prerequisites](#prerequisites)\n1. [Installation](#installation)\n1. [Usage](#usage)\n    - [Options](#options)\n    - [Run](#run)\n1. [Generated Artifacts](#generated-artifacts)\n1. [Development](#development)\n1. [Testing](#testing)\n1. [Contributing](#contributing)\n\n## Prerequisites\nTo use this module, you will need Node.js and Swift 5.0 installed on your Linux or macOS system. You can get Node.js from https://nodejs.org and Swift 5.0 from https://swift.org/download.\n\nYou will also need the Yeoman command line utility [yo](https://github.com/yeoman/yo) installed in your global Node.js module directory.\n\nTo install `yo`, run:\n\n```bash\nnpm install -g yo\n```\n\n## Installation\nTo install generator-swiftserver, run:\n\n```bash\nnpm install -g generator-swiftserver\n```\n\n## Usage\nTo create a Swift Server Generator project with no models defined, run:\n\n```bash\nyo swiftserver\n```\n\nTo add a data model to your generated project, `cd` to the new project directory and run:\n\n```bash\nyo swiftserver:\u003cmodel\u003e\n```\n\nFor more information on data models, check out [this guide on Kitura.io](https://www.kitura.io/guides/kituracli/model_definition.html).\n\n### Options\nYou can also change how generator-swiftserver is invoked by choosing options:\n\n```bash\nyo swiftserver [options]\n```\n\nOption | Type |Description\n--- | --- | ---\n`--init` | n/a | Generate basic default scaffold without prompting user for input.\n`--skip-build` | n/a | Skip building the generated application\n`--single-shot` | n/a | Creates application without including generator metadata files\n`--bluemix` | Json | Invoke generator-swiftserver using a bluemix json object\n`--name` | String | Project name\n`--type` | String | Give a specific type of application to generate. (`web`, `bff`, `scaffold`, `crud`)\n`--metrics` | Boolean | Generate embedded metrics dashboard for project\n`--docker` | Boolean | Generate Dockerfile for project\n`--healthcheck` | Boolean | Add health checking to project\n`--openapi` | Boolean | Add Kitura-OpenAPI to project\n`--spec` | Json | Invoke generator-swiftserver using a spec json object\n\n### Run\nTo run the generated server, use: `\u003cproject-dir\u003e/.build/debug/\u003capp-name\u003e`\n\n## Generated Artifacts\n\nFile | Purpose\n--- | ---\nDockerfile | Configuration file for the run container\nDockerfile-tools | Configuration file for the tools container\nLICENSE | License for generated project\nPackage.resolved | Results of dependency resolution from Swift Package Manager\nPackage.swift | Swift file containing dependencies and targets for project\nREADME.md | Instructions for building, running, and deploying the project\nSources/* | Folder containing project source files\nTests/* | Folder containing project test files\nchart/* | Folder containing Kubernetes Helm Chart files for project\ncli-config.yml | Yaml file containing mappings for various commands, files, and settings, utilized by the cli commands\nmanifest.yml | Yaml file containing various information for deployment to IBM Cloud\nspec.json | JSON file containing information about the project, used to generate the project\nmyProjectName.xcodeproj | Generated xcodeproj for project\n\n## Development\nTo get started with development, simply clone this repository and link it via npm:\n\n```\ngit clone https://github.com/IBM-Swift/generator-swiftserver\ncd generator-swiftserver\nnpm link\n```\n\n## Testing\nTo run the unit tests, run:\n\n```bash\nnpm test\n```\n\n## Contributing\nTo contribute, you will need to fork the repository or branch off the `develop` branch.\n\nMake sure to follow the [conventional commit specification](https://conventionalcommits.org/) when contributing.\n\nOnce you are finished with your changes, run `npm test` to make sure all tests pass. Then, create a pull request against `develop`, and a team member will review and merge your pull request.\n\nOnce the pull request is merged, an auto generated pull request will be created against `master` to update the changelog and increase the versioning. After the auto-generated pull request has been merged to `master`, the version will be bumped and published to npm.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIBM-Swift%2Fgenerator-swiftserver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FIBM-Swift%2Fgenerator-swiftserver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIBM-Swift%2Fgenerator-swiftserver/lists"}