add initial readme (#5)

Signed-off-by: Manabu McCloskey <manabu.mccloskey@gmail.com>
This commit is contained in:
Manabu McCloskey 2024-06-06 10:00:27 -07:00 committed by GitHub
parent 388a1b5b4f
commit d0d6606a43
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

18
README.md Normal file
View file

@ -0,0 +1,18 @@
# CNOE Stacks
This repository contains building blocks and examples to help you build your own Internal Developer Platform.
## Getting Started
### Install idpbuilder
To get started, you need to install [`idpbuilder`](https://github.com/cnoe-io/idpbuilder).
See [the instructions](https://github.com/cnoe-io/idpbuilder?tab=readme-ov-file#getting-started) in the idpbuilder repository for details.
### Using this repository
- **[CNOE Reference Implementation](./ref-implementation)**. Create a local CNOE environment in minutes.
- **[Basic Examples](./basic)**. Do you want to know how to use idpbuilder with basic examples?
- **[Local Backup](./local-backup)**. How do I make sure my work is backed up?
- **[Localstack](./localstack-integration)**. Use [LocalStack](https://github.com/localstack/localstack) to test out cloud integrations.
- **[Terraform Integrations](./terraform-integrations)**. Integrating Terraform with Reference Implementation.