UNPKG

1.95 kBMarkdownView Raw
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[![GitHub CI status](https://github.com/architect/architect/workflows/Node%20CI/badge.svg)](https://github.com/architect/architect/actions?query=workflow%3A%22Node+CI%22) [![Join Architect Slack](https://img.shields.io/badge/Slack-join!-blue?style=flat&logo=slack)](https://join.slack.com/t/architecture-as-text/shared_invite/MjE2MzU4Nzg0NTY1LTE1MDA2NzgyMzYtODE2NzRkOGRmYw)
8<!-- [![codecov](https://codecov.io/gh/architect/architect/branch/master/graph/badge.svg)](https://codecov.io/gh/architect/architect) -->
9
10
11## Docs
12
13Full documentation found at: https://arc.codes
14
15
16## Installation
17
18### `npm`
19```
20npm i -g @architect/architect
21```
22
23
24### Binary Distributions
25
26Coming 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`.
27
28
29## Usage
30
31Run `arc` with no arguments to get help. To create a new app and kick up the local dev server:
32
33```
34mkdir testapp
35cd testapp
36arc init
37arc sandbox
38```
39
40Package and deploy your app (via AWS CloudFormation):
41
42```
43arc deploy
44```
45
46
47### Founding team
48
49[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)
50
51
52### Special thanks
53
54[Pinyao Guo](https://github.com/pug132) for the [Architect GitHub name](https://github.com/architect)