-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
62 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,89 +1,90 @@ | ||
| <img src="docs/images/mantil-logo-lockup-1-orange-RGB.png" height="120px"> | ||
| <p>Open-source serverless development kit for Go and AWS Lambda</p> | ||
|
|
||
| [![License][License-Image]][License-Url] [![Slack][Slack-Image]][Slack-Url]  [](https://codecov.io/gh/mantil-io/mantil) | ||
| [![License][License-Image]][License-Url] [![Slack][Slack-Image]][Slack-Url]  | ||
|
|
||
| [License-Url]: https://github.com/mantil-io/mantil/blob/master/LICENSE | ||
| [License-Image]: https://img.shields.io/badge/license-MIT-blue | ||
|
|
||
| [Slack-Image]: https://img.shields.io/badge/chat-on%20slack-green | ||
| [Slack-Url]: https://join.slack.com/t/mantilcommunity/shared_invite/zt-z3iy0lsn-7zD_6nqEucsgygTvHmnxAw | ||
|
|
||
| # | ||
| # Serverless development kit for Go and AWS Lambda | ||
|
|
||
| Cloud-native development demands a new approach to building, launching and | ||
| observing cloud apps. [Mantil](https://www.mantil.com) is a modern Go toolset for creating and managing | ||
| AWS Lambda projects. | ||
| Cloud-native development demands a new approach to building, launching, and observing cloud apps. [Mantil](https://www.mantil.com) is a modern open-source framework for writing serverless apps in Go. It allows you to quickly create and deploy applications that use AWS Lambda over a command line interface. | ||
|
|
||
| In this early version, Mantil addresses fundamental issues often encountered | ||
| while building and launching the apps: | ||
| * setting up a new AWS Lambda project from scratch or an existing template | ||
| * setting up a local development environment and tying everything with AWS | ||
| * deploying the app on every change | ||
| * code testing via standard go tests or by invoking a specific function | ||
| * getting logs instantly | ||
| * supporting multiple development stages and parallel lines of deployment | ||
| ## About Mantil | ||
| ### 🧑💻 Tailored for developers | ||
| There are many serverless tools out there focused on building infrastructure. In Mantil, developers write pure Go code without any notion of AWS or Lambda. Therefore, you don't need an upfront understanding of the complex AWS ecosystem and tooling. | ||
|
|
||
| Please, go and try it! [Let us know](mailto:[email protected]?subject=Mantil%20feedback) your thoughts. | ||
| <p align="center"> | ||
| <img src="docs/images/mantil_project_structure.png" height="400px"> | ||
| <p/> | ||
|
|
||
| ## Installation | ||
| ### ☁️ Cloud environments | ||
| Get the feeling of local development while using real services in the cloud. With built-in support for multiple development stages and parallel lines of deployment, you still keep your private development sandbox. But in the serverless world, all environments are essentially the same environments. | ||
|
|
||
| ### Homebrew (Mac and Linux) | ||
| ### 🤩 Continuous deployment | ||
| Many developers who have played with AWS Lambda complain about frustrating build experiences where you need to make a number of steps manually. With **mantil watch** app is deployed automatically on every save. Moreover, it is done in seconds, so fluid development workflow is preserved. | ||
|
|
||
| Use [Homebrew](https://brew.sh) to install the latest version: | ||
| <p align="center"> | ||
| <img src="docs/images/mantil_watch.png" height="250px"> | ||
| <p/> | ||
|
|
||
| ``` | ||
| brew tap mantil-io/mantil | ||
| brew install mantil | ||
| ``` | ||
| ### 👉 Data storage | ||
| A key consideration when developing applications is choosing the right data storage option. To help you, Mantil comes with a predefined [S3Bucket](https://github.com/mantil-io/mantil.go/blob/845476e8b2dae9333158fab6a48c7779423841a9/s3.go#L47) function and [KV store](https://github.com/mantil-io/mantil.go/blob/845476e8b2dae9333158fab6a48c7779423841a9/kv.go#L32) implementation backed by DynamoDB. | ||
|
|
||
| ### Direct Download (Linux, Windows and Mac) | ||
| Mantil also supports **code testing** via standard go tests or by invoking a specific function and **getting logs instantly** during function execution (not after the function is completed). And much more. | ||
|
|
||
| Below are the available downloads for the latest version of Mantil. Please | ||
| download the right package for your operating system and architecture. | ||
|
|
||
| Mantil is distributed as a single binary. Install Mantil by extracting it and | ||
| moving it to a directory included in your system's PATH. | ||
| ## Quick Start | ||
| To get started with Mantil, you need to have installed Go and access to AWS account. Follow these few simple steps, and you will be up and running in minutes. | ||
|
|
||
| | OS | Architecture | Download link | | ||
| | --------| ------------ | ---------------------------------------------------------------------------------------------------------------------------- | | ||
| | Darwin | arm64 | [mantil_Darwin_arm64.tar.gz](https://s3.eu-central-1.amazonaws.com/releases.mantil.io/latest/mantil_Darwin_arm64.tar.gz) | | ||
| | Darwin | x86_64 | [mantil_Darwin_x86_64.tar.gz](https://s3.eu-central-1.amazonaws.com/releases.mantil.io/latest/mantil_Darwin_x86_64.tar.gz) | | ||
| | Linux | x86_64 | [mantil_Linux_x86_64.tar.gz](https://s3.eu-central-1.amazonaws.com/releases.mantil.io/latest/mantil_Linux_x86_64.tar.gz) | | ||
| | Linux | i386 | [mantil_Linux_i386.tar.gz](https://s3.eu-central-1.amazonaws.com/releases.mantil.io/latest/mantil_Linux_i386.tar.gz) | | ||
| | Linux | arm64 | [mantil_Linux_arm64.tar.gz](https://s3.eu-central-1.amazonaws.com/releases.mantil.io/latest/mantil_Linux_arm64.tar.gz) | | ||
| | Linux | arm | [mantil_Linux_arm.tar.gz](https://s3.eu-central-1.amazonaws.com/releases.mantil.io/latest/mantil_Linux_arm.tar.gz) | | ||
| | Windows | x86_64 | [mantil_Windows_x86_64.tar.gz](https://s3.eu-central-1.amazonaws.com/releases.mantil.io/latest/mantil_Windows_x86_64.tar.gz) | | ||
| | Windows | i386 | [mantil_Windows_i386.tar.gz](https://s3.eu-central-1.amazonaws.com/releases.mantil.io/latest/mantil_Windows_i386.tar.gz) | | ||
| ``` | ||
| # Install Mantil CLI | ||
| $ brew tap mantil-io/mantil | ||
| $ brew install mantil | ||
| # Install Mantil Node on AWS | ||
| $ mantil aws install --aws-profile=my-named-profile | ||
| ### An example for Linux x86_64 | ||
| # Create your first Mantil project (it just creates project structure) | ||
| $ mantil new my-project | ||
| $ cd my-project | ||
| # Deploy your project to development stage | ||
| $ mantil stage new development | ||
| ``` | ||
| wget https://s3.eu-central-1.amazonaws.com/releases.mantil.io/latest/mantil_Linux_x86_64.tar.gz | ||
| tar xvfz mantil_Linux_x86_64.tar.gz | ||
| mv mantil /usr/local/bin | ||
| ``` | ||
| And that's it, you've created your first serverless app using Mantil. | ||
| Read [Getting Started](https://github.com/mantil-io/mantil/blob/master/docs/getting_started.md) tutorial or watch the [accompanying video](https://www.youtube.com/watch?v=Fp64VgSLoTQ) to dive deep into each step and to learn more about how to work with Mantil. | ||
|
|
||
| Mantil CLI is also available on Windows and Linux via [direct download](https://github.com/mantil-io/mantil/blob/master/docs/installation.md). | ||
|
|
||
|
|
||
| ## Documentation | ||
| Check out [documentation](https://github.com/mantil-io/mantil/blob/master/docs/readme.md) to get into specific areas of Mantil: | ||
| * familiarize yourself with [General Concepts](https://github.com/mantil-io/mantil/blob/master/docs/concepts.md) | ||
| * learn more about [testing principles](https://github.com/mantil-io/mantil/blob/master/docs/testing.md) | ||
| * find out how to configure environment variables, scheduled execution, private API's or custom domain in [API Configuration](https://github.com/mantil-io/mantil/blob/master/docs/api_configuration.md) | ||
| * get an overview of all available [CLI commands](https://github.com/mantil-io/mantil/blob/master/docs/commands/README.md) | ||
| * find answers to most common questions in [FAQ](https://github.com/mantil-io/mantil/blob/master/docs/faq.md) | ||
|
|
||
| ## Examples | ||
| Choose from among several guided tutorials that will give you step-by-step examples of various features of Mantil: | ||
| * [Chat](https://github.com/mantil-io/template-chat) - demonstrates WebSocket Mantil API interface | ||
| * [Todo](https://github.com/mantil-io/template-todo) - simple todo app showcasing persistent key/value storage | ||
| * [Signup](https://github.com/mantil-io/example-signup) - example of simple signup workflow | ||
| * [Excuses](https://github.com/mantil-io/template-excuses) - UI and environment variables showcase | ||
| * [Github to Slack](https://github.com/mantil-io/template-github-to-slack) - example of serverless integration between GitHub and Slack | ||
| * [HN alerts](https://github.com/mantil-io/example-hn-alerts) - example of scheduled lambda function that will look for new HackerNews stories containing certain keywords | ||
| * [Mongo Atlas](https://github.com/mantil-io/example-mongo-atlas) - example of using Mantil with Mongo Atlas | ||
| * [Presigned s3 upload](https://github.com/mantil-io/template-presigned-s3-upload) - template showing upload of files to S3 bucket through presigned URLs | ||
| * [NGS chat](https://github.com/mantil-io/example-ngs-chat) - example of chat implemented with [NATS](https://github.com/nats-io) | ||
|
|
||
| ## Feedback | ||
| We'd love to hear from you. Mantil is in early beta, and we are continuously improving it. If you would like to see additional features or want to chat with us join our [Slack Community](https://join.slack.com/t/mantilcommunity/shared_invite/zt-z3iy0lsn-7zD_6nqEucsgygTvHmnxAw). | ||
|
|
||
| # | ||
| <p align="center"> ⭐️ If you like Mantil, give it a star! ⭐️</p> | ||
|
|
||
|
|
||
| We suggest to check out [Getting started](docs/getting_started.md) and familiarize yourself with [General | ||
| Concepts](docs/concepts.md). | ||
|
|
||
| * [Getting Started](docs/getting_started.md) | ||
| * [General Concepts](docs/concepts.md) | ||
| * [FAQ](docs/faq.md) | ||
| * [Other](docs/readme.md) documentation topics | ||
|
|
||
| Start exploring by creating Mantil project from one of the templates: | ||
| * [ping](https://github.com/mantil-io/template-ping) - default template for new Mantil projects | ||
| * [excuses](https://github.com/mantil-io/template-excuses) - UI and environment variables showcase | ||
| * [chat](https://github.com/mantil-io/template-chat) - demonstrates WebSocket Mantil API interface | ||
| * [todo](https://github.com/mantil-io/template-todo) - simple todo app showcasing persistent key/value storage | ||
| * [github-to-slack](https://github.com/mantil-io/template-github-to-slack) - example of serverless integration between GitHub and Slack | ||
| * [hn-alerts](https://github.com/mantil-io/example-hn-alerts) - example of scheduled lambda function that will look for new HackerNews stories containing certain keywords | ||
| * [signup](https://github.com/mantil-io/example-signup) - example of simple signup workflow | ||
| * [mongo-atlas](https://github.com/mantil-io/example-mongo-atlas) - example of using Mantil with Mongo Atlas | ||
| * [presigned-s3-upload](https://github.com/mantil-io/template-presigned-s3-upload) - template showing upload of files to S3 bucket through presigned URLs | ||
| * [ngs-chat](https://github.com/mantil-io/example-ngs-chat) - example of chat implemented with NATS | ||
|
|