| 1 | [<img src="https://s3-us-west-2.amazonaws.com/arc.codes/architect-logo-500b@2x.png" width=500>](https://www.npmjs.com/package/@architect/architect)
|
| 2 |
|
| 3 | ## [`@architect/architect`](https://www.npmjs.com/package/@architect/architect)
|
| 4 |
|
| 5 | > Create, deploy, and maintain next-generation AWS cloud function-based serverless infrastructure with full local, offline workflows, and more.
|
| 6 |
|
| 7 | [](https://travis-ci.com/architect/architect) [](https://ci.appveyor.com/project/ArchitectCI/architect/branch/master) [](https://codecov.io/gh/architect/architect)
|
| 8 |
|
| 9 |
|
| 10 | ## Docs
|
| 11 |
|
| 12 | Full documentation found at: https://arc.codes
|
| 13 |
|
| 14 |
|
| 15 | ## Installation
|
| 16 |
|
| 17 | ### `npm`
|
| 18 | ```
|
| 19 | npm i -g @architect/architect
|
| 20 | ```
|
| 21 |
|
| 22 |
|
| 23 | ### Binary Distributions
|
| 24 |
|
| 25 | Coming soon! If you are interested in helping please let us know! Currently you can generate experimental binaries by cloning this repo and running `npm run build`.
|
| 26 |
|
| 27 |
|
| 28 | ## Usage
|
| 29 |
|
| 30 | Run `arc` with no arguments to get help. To create a new app and kick up the local dev server:
|
| 31 |
|
| 32 | ```
|
| 33 | mkdir testapp
|
| 34 | cd testapp
|
| 35 | arc init
|
| 36 | arc sandbox
|
| 37 | ```
|
| 38 |
|
| 39 | Package and deploy your app (via AWS CloudFormation):
|
| 40 |
|
| 41 | ```
|
| 42 | arc deploy
|
| 43 | ```
|
| 44 |
|
| 45 |
|
| 46 | ### Founding team
|
| 47 |
|
| 48 | [Amber Costley](https://github.com/amberdawn), [Angelina Fabbro](https://github.com/afabbro), [Brian LeRoux](https://github.com/brianleroux), Jen Fong-Adwent, [Kristofer Joseph](https://github.com/kristoferjoseph), [Kris Borchers](https://github.com/kborchers), [Ryan Block](https://github.com/ryanblock), [Spencer Kelley](https://github.com/spencermountain)
|
| 49 |
|
| 50 |
|
| 51 | ### Special thanks
|
| 52 |
|
| 53 | [Pinyao Guo](https://github.com/pug132) for the [Architect GitHub name](https://github.com/architect)
|