https://github.com/microlambda/microlambda

:zap: Microlambda is an opinionated framework that allows you to manage large serverless projects on AWS Lambda, written in TypeScript.
https://github.com/microlambda/microlambda

aws lambda microservices monorepo typescript

Last synced: about 4 hours ago
JSON representation

:zap: Microlambda is an opinionated framework that allows you to manage large serverless projects on AWS Lambda, written in TypeScript.

• Host: GitHub
• URL: https://github.com/microlambda/microlambda
• Owner: microlambda
• License: mit
• Created: 2021-03-24T08:47:40.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T16:12:54.000Z (8 days ago)
• Last Synced: 2024-09-22T21:02:22.337Z (2 days ago)
• Topics: aws, lambda, microservices, monorepo, typescript
• Language: TypeScript
• Homepage: https://microlambda.dev
• Size: 11.4 MB
• Stars: 3
• Watchers: 0
• Forks: 2
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Microlambda



  



Is an opinionated framework that simplifies development of AWS serverless microservices

project using typescript.

## Sponsors



    


        

    


    


        Neoxia - The 360 Cloud Company

    



## User documentation

A complete user guide is available on our [official website](https://microlambda.dev)

## Developer documentation

The project is maintained as a monorepo (using yarn workspaces) and contains the following packages:

* `@microlambda/core` Core package that contains all low-level logic to run microlambda projects.

* `@microlambda/cli` A command line interface that provides tooling to generate, run, test and deploy projects.

* `@microlambda/generator` A command line interface that provides tooling to generate, run, test and deploy projects.

* `@microlambda/client` The web UI to monitor and interact with the microservices during local runs.

* `@microlambda/server` The WebSocket server that send data to client and handle its requests for local run UI.

* `@microlambda/handling` Helpers that automates repetitive tasks such as CORS configuration, build responses.

* `@microlambda/testing` Tests helpers for easy unit and functional tests setup. 

* `@microlambda/plugin` Serverless framework plugin that enable custom domain creation and multi-regions deployments. 

* `@microlambda/docs` Project documentation website. Powered by docusaurus.

### Project first build

```bash

# Clone this repository

git clone [email protected]:microlambda/microlambda.git

# Install dependencies

yarn

# Mila is designed to build itself, to do so, build mila-runner

yarn build:runner

# Once the runner is built, use it to build the entire project

yarn build --watch

```

To perform tests, fork the [mila-starter](https://github.com/microlambda/mila-starter) or use one of your microlambda project.

Update your ``package.json`` to use yarn `link:` special protocol and use your local version of mila and run `yarn install`.

```json

{

  "dependencies": {

    "@microlambda/cli": "link:/path/to/your/clone/microlambda/cli",

    "serverless-microlambda": "link:/path/to/your/clone/microlambda/plugin"

  }

}

```

With this setup, you are using a local version of microlambda which is rebuilt with `build --watch` on another shell.

When you edit microlambda, changes are immediately available on your test project.

You have a proper DX to fix a bug or develop a new feature :triangular_ruler: