Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.

Commit b3f93a3

Browse files
committed
feat: add infra README
1 parent 19e5152 commit b3f93a3

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

infra/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# DeckDeckGo - Infrastructure
2+
3+
This project is the infrastructure of [DeckDeckGo].
4+
5+
The infrastructure is deployed with [Terraform] and runs on [AWS Lambda].
6+
7+
## Getting started
8+
9+
**requirements: [Nix]**
10+
11+
To (re)deploy the infrastructure, run the following commands:
12+
13+
``` shell
14+
$ cd infra/
15+
$ nix-shell
16+
$ terraform apply
17+
```
18+
19+
Running `nix-shell` drops you in a shell where all the dependencies are
20+
available. Running `terraform apply` will package everything needed by the
21+
lambda function and upload it to AWS. **NOTE**: if you are deploying from a new
22+
machine you may need to run `terraform init`.
23+
24+
## Table of contents
25+
26+
- [License](#license)
27+
28+
## License
29+
30+
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia]([email protected])
31+
32+
[DeckDeckGo]: https://deckdeckgo.com
33+
[Terraform]: https://www.terraform.io/
34+
[AWS Lambda]: https://aws.amazon.com/lambda/
35+
[Nix]: https://nixos.org/nix/

0 commit comments

Comments
 (0)