https://github.com/bdrelling/doccmiddleware-example

An example project for the DocCMiddleware package.
https://github.com/bdrelling/doccmiddleware-example

docc example middleware swift vapor website

Last synced: 28 days ago
JSON representation

An example project for the DocCMiddleware package.

• Host: GitHub
• URL: https://github.com/bdrelling/doccmiddleware-example
• Owner: bdrelling
• License: mit
• Created: 2022-08-23T04:05:43.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-15T03:37:13.000Z (over 2 years ago)
• Last Synced: 2024-10-13T19:51:02.566Z (2 months ago)
• Topics: docc, example, middleware, swift, vapor, website
• Language: Swift
• Homepage: https://briandrelling.com
• Size: 279 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DocCMiddleware-Example

[![CI Status](https://github.com/bdrelling/DocCMiddleware-Example/actions/workflows/tests.yml/badge.svg)](https://github.com/bdrelling/DocCMiddleware-Example/actions/workflows/tests.yml)

[![Swift Compatibility](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fbdrelling%2FDocCMiddleware%2Fbadge%3Ftype%3Dswift-versions&label=)](https://swiftpackageindex.com/bdrelling/DocCMiddleware)

[![Platform Compatibility](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fbdrelling%2FDocCMiddleware%2Fbadge%3Ftype%3Dplatforms&label=)](https://swiftpackageindex.com/bdrelling/DocCMiddleware)

[![License](https://img.shields.io/github/license/bdrelling/Template-Swift?label=)](https://github.com/bdrelling/Template-Swift/blob/main/LICENSE)

An example project for the DocCMiddleware package.

## Running the Website

Type `swift run Example` into your terminal from the root of the repository to run the example website. The command will output the URL to navigate to, which will most likely be `http://127.0.0.1:8080`.

### Example Output

```sh

$ swift run Example

Building for debugging...

Build complete! (0.18s)

[ NOTICE ] Server starting on http://127.0.0.1:8080

```

## Generate Documentation

Regenerate documentation by running `scripts/docgen.sh` from the root of the repository.

## More Examples

For more examples, see [bdrelling/DocCMiddleware](https://github.com/bdrelling/doccmiddleware#examples).

## License

This project is released under the MIT license. See [LICENSE](/LICENSE) for details.