diff --git a/README.md b/README.md index 4d0c6b27..6f9365b5 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,8 @@ Port: 5050 ``` Behind the scenes: `teller` fetched the correct variables, placed those (and _just_ those) in `ENV` for the `node` process to use. +# Best practices +Go and have a look at a collection of our [best practices](./best-practices.md) # Features diff --git a/best-practices.md b/best-practices.md new file mode 100644 index 00000000..53e5a76c --- /dev/null +++ b/best-practices.md @@ -0,0 +1,12 @@ +# Intro +This is a list of some of the best practices using this tool. Please contribute if you have any additions or changes to current or non existing best practices + +* [`Different envs`](#different-envs). + +# Different envs +We primarily use 2 methods: + +* A single file, where each environment is a parameter, see prompts and options, where you can populate one with an environment variable env:STAGE and STAGE=dev teller ... +* Keep a config file per environment, similar to what you would do with .env file (.env.example, .env.production, etc.) -- but with teller none of configuration files contain any sensitive information (as opposed to .env) so you're safe. + +The best practice really depends on the size of your team and how you prefer to work. We imagine if the team is small, and the use cases are not many, a single file would be great. If the team is large, or maybe you're enabling other teams -- keeping a file per environment would be better, and this way you can "distribute" your teller files per use case in a central way. \ No newline at end of file