https://github.com/devklick/fbwrld
https://github.com/devklick/fbwrld
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devklick/fbwrld
- Owner: devklick
- Created: 2023-05-15T12:16:55.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-05-15T13:00:06.000Z (about 3 years ago)
- Last Synced: 2025-01-18T08:45:13.059Z (over 1 year ago)
- Language: TypeScript
- Size: 192 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
FbWrld
A fullstack football application
> **Warning**
This is very much WIP
# Deploying the stack locally
This application makes use of [Serverless](https://www.serverless.com/) and [LocalStack](https://localstack.cloud/). As such, you can deploy and run the entire stack locally.
## Prerequisites
- Make sure you have the [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) installed.
- Make sure you have the [Serverless CLI](https://www.serverless.com/framework/docs/getting-started) installed.
- [Optional] Install the [LocalStack AWS CLI](https://github.com/localstack/awscli-local) (aka `awslocal`).
## Clone and install
Obviously, you'll need to clone the repo and install the npm package.
```
git clone https://github.com/devklick/fbwrld
cd fbwrld
npm i
```
## Starting LocalStack
Assuming you have the LocalStack CLI set up, you can run the following in a terminal to start the LocalStack environment.
```
localstack start
```
It's best to keep this open in a separate terminal so you can refer to it later. Some useful logs get printed here.
## Deploying the stack
With the LocalStack environment now running, we can run the following in a new terminal window/tab and the Serverless CLI will orchestrate the deployment of our stack to the LocalStack environment:
```
serverless deploy --stage local
```
While the stack is being deployed, you should see information being printed to the LocalStack CLI terminal to let you know the progress of the deployment.