Helsingborg IO SLS

Services that run on Helsingborgs stads API platform helsingborg.io
Report Bug · Request Feature

Table of Contents

• Table of Contents
• About Helsingborg IO SLS
  • An example
  • Built With
• Getting Started
  • Do first
  • Prerequisites
  • Installation
• Services
• Roadmap
• Contributing
• License

About Helsingborg IO SLS

A service is what you might call a Serverless project. It has a single serverless.yml file driving it.

An example

Our app has two API services, each has their own well defined business logic:

• forms-api service: Handles managing the forms data.
• cool-api service: Handles making cool suff.

/
  libs/
  services/
    forms-api/
    cool-api/

Why? Most of the code changes are going to happen in this repo. When your team is making rapid changes, you are likely to have many feature branches, bug fixes, and pull requests. A bonus with serverless is that you can spin up new environments at zero cost (you only pay for usage, not for provisioning resources).

For example, a team can have dozens of ephemeral stages such as: prod, staging, dev, feature-x, feature-y, feature-z, bugfix-x, bugfix-y, pr-128, pr-132, etc.

This ensures each change is tested on real infrastructure before being promoted to production.

Built With

• Serverless Framework
• AWS

Getting Started

Do first

The services are dependent on the resources that are created in this accompanying repo.

Prerequisites

• AWS CLI
• AWS Account
• AWS IAM user
• Homebrew (macOS)
• NodeJS
• NPM
• Serverless Framework

Installation

Clone repo

git clone [email protected]:helsingborg-stad/helsingborg-io-sls-api.git

Install shared npm packages

cd helsingborg-io-sls-api
npm install

Services

Every service in this mono repo has its own documentation. Follow links below.

• Auth
  • Token
• Bankid API
• Booking API
• Cases API
• Forms API
• Navet MS
• Search API
• Users API
• Users MS
• Viva MS

Roadmap

This repo is part of a project called Mitt Helsingborg. See the project backlog for a complete list of upcoming features, known issues and releases.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. 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.