https://github.com/nearform/mira

The Mira Accelerator fast-tracks the setup of common Amazon Web Services (AWS) Serverless infrastructure
https://github.com/nearform/mira

Last synced: 3 months ago
JSON representation

The Mira Accelerator fast-tracks the setup of common Amazon Web Services (AWS) Serverless infrastructure

• Host: GitHub
• URL: https://github.com/nearform/mira
• Owner: nearform
• License: other
• Archived: true
• Created: 2020-06-18T09:50:35.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-05-18T14:10:36.000Z (over 1 year ago)
• Last Synced: 2024-07-17T08:45:39.137Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 4.69 MB
• Stars: 13
• Watchers: 42
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![Logo][logo-img]][docs]

# What is Mira?

The Mira Accelerator fast-tracks the setup of common Amazon Web Services (AWS) Serverless infrastructure1. 

It is an opinionated toolkit on top of the AWS Cloud Development Kit.

It enables you to:

- Quickly bootstrap serverless, cloud native AWS applications.

- Set up a CI platform that is configured and ready to use.

- Shortcut a lot of technical decisions; Mira makes them for you.

Mira consists of the following built-ins:

 * A Command Line Interface, that helps to initialise and deploy applications, and also to deploy a CI pipeline.

 * Foundational constructs that simplify configuration of multiple application environments.

 * Bundled AWS CDK.

 * An opinionated set of AWS CDK aspects, e.g. IAM Policy validator. 

 * Complementary sample applications e.g. a simple S3-based web hosting app.

 

# Official documentation

💡 To get the complete picture of Mira, view our __[docs][docs]__.

# Documentation

Use the following command to run the Mira documentation on your local machine:

```

npm run docs

```

# Contribute to Mira

Refer to the section [Contribute to Mira](./CONTRIBUTING.md) if you wish to contribute to Mira. 

[logo-img]: docs/img/Accel_Logo_Mira.svg

[docs]: https://nf-mira.netlify.com/?#/

[nvm]: https://github.com/nvm-sh/nvm

[Duplicating a repository]: https://help.github.com/en/github/creating-cloning-and-archiving-repositories/duplicating-a-repository