https://github.com/faasjs/starter

🔨 A starter template for FaasJS
https://github.com/faasjs/starter

bolierplate faas nodejs severless typescript

Last synced: about 1 year ago
JSON representation

🔨 A starter template for FaasJS

• Host: GitHub
• URL: https://github.com/faasjs/starter
• Owner: faasjs
• Created: 2021-09-11T08:51:29.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2025-04-24T02:12:01.000Z (about 1 year ago)
• Last Synced: 2025-04-24T03:23:14.379Z (about 1 year ago)
• Topics: bolierplate, faas, nodejs, severless, typescript
• Language: TypeScript
• Homepage: https://faasjs.com
• Size: 7.3 MB
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# FaasJS Starter

[![Testing](https://github.com/faasjs/starter/actions/workflows/testing.yml/badge.svg)](https://github.com/faasjs/starter/actions/workflows/testing.yml)

A starter template for [FaasJS](https://faasjs.com).

## Quick Start with codespace

1. Click `Code` -> `Codespaces` -> `Create codespace on main`.

2. Wait for the codespace to be created.

3. In VS Code, open a new terminal and run `ni && nd` (shorten command of `npm install && npm run dev`).

4. Enjoy!

## Run Locally with macOS

### System Requirements

- Latest stable **macOS**

- Latest stable **Docker** https://www.docker.com/

- Latest stable **Visual Studio Code** https://code.visualstudio.com/

### Setup

1. Use VS Code to open project.

2. Install VS Code extension: `ms-vscode-remote.vscode-remote-extensionpack`.

3. In VS Code, click `F1` then choose `Remote-Containers: Reopen in Container`.

4. In VS Code, open a new terminal `ni && nd` (shorten command of `npm install && npm run dev`).

5. Open `http://localhost:3000/` in browser.

### Test

`nt` (shorten command of `npm run test`)