README.md

Helsingborg IO CDN

REST API that delivers Guide data.

Report Bug · Request Feature

Table of Contents

• Table of Contents
• About Helsingborg IO CDN
  • Built With
• Getting Started
  • Installation
  • Commands
  • Usage
• Contributing
• License

About Helsingborg IO CDN

REST API that delivers Guide data originated from Helsingborg stads Event API. Currently serves as backend for the app Guide Helsingborg.

Built With

• Serverless Stack (SST)

Getting Started

Installation

Clone the repo

$ git clone https://github.com/helsingborg-stad/cdn-helsingborg-io.git

Install dependencies

$ yarn install

Commands

yarn run start

Starts the local Lambda development environment.

yarn run build

Build your app and synthesize your stacks.

Generates a .build/ directory with the compiled files and a .build/cdk.out/ directory with the synthesized CloudFormation stacks.

yarn run deploy [stack]

Deploy all your stacks to AWS. Or optionally deploy, a specific stack.

yarn run remove [stack]

Remove all your stacks and all of their resources from AWS. Or optionally removes, a specific stack.

yarn run test

Runs your tests using Jest. Takes all the Jest CLI options.

yarn export-docs [rest-api-name] [stage-name]

Export API as Swagger specification.

yarn run-docs

Run local Swagger UI server

Usage

To visualize and interact with the API’s resources, see the Swagger UI documentation.

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.