Architect

The simplest, most powerful way to build a functional web app (fwa)

README

GitHub CI status npm version Apache-2.0 License


Build ultra scalable database backed web apps on AWS serverless infrastructure with full local, offline workflows, and more. Full documentation found at: https://arc.codes



Requirements


- Platforms: Linux, macOS, Windows
- Architect runtime: Node.js 14+
- Function runtimes & package managers:
  - Node.js (optional): supported versions
    - [npm](https://www.npmjs.com/) (optional): 6+
    - [yarn](https://yarnpkg.com/) (optional): 1+
  - Python (optional): supported versions
    - [pip3](https://pip.pypa.io/en/stable/) (optional)
  - Ruby (optional): supported versions
    - [bundle](https://bundler.io/) (optional)
- Additional function runtimes:
  - Java, .NET, Golang, Lambda runtime layers (optional): supported versions


Installation


Make sure you have at least node version 14 installed.

Open your terminal to install arc globally:

  1. ```bash
  2. npm i -g @architect/architect
  3. ```

Check the version:

  1. ```bash
  2. arc version
  3. ```

Protip: run arc with no arguments to get help



Work locally


Create a new app:

  1. ```bash
  2. mkdir testapp
  3. cd testapp
  4. arc init
  5. ```

Kick up the local dev server:

  1. ```bash
  2. arc sandbox
  3. ```

Cmd / Ctrl + c exits the sandbox



Deploy to AWS


Deploy the staging stack:

  1. ```bash
  2. arc deploy
  3. ```

Protip: create additional staging stacks with --name


Ship to a production stack:

  1. ```bash
  2. arc deploy production
  3. ```


Add Architect syntax to your text editor




Atom


Learn more


Head to https://arc.codes to learn more!



Founding team




Special thanks