aboutsummaryrefslogtreecommitdiff
path: root/config/env.cr
diff options
context:
space:
mode:
Diffstat (limited to 'config/env.cr')
-rw-r--r--config/env.cr33
1 files changed, 33 insertions, 0 deletions
diff --git a/config/env.cr b/config/env.cr
new file mode 100644
index 0000000..3f36407
--- /dev/null
+++ b/config/env.cr
@@ -0,0 +1,33 @@
+# Environments are managed using `LuckyEnv`. By default, development, production
+# and test are supported. See
+# https://luckyframework.org/guides/getting-started/configuration for details.
+#
+# The default environment is development unless the environment variable
+# LUCKY_ENV is set.
+#
+# Example:
+# ```
+# LuckyEnv.environment # => "development"
+# LuckyEnv.development? # => true
+# LuckyEnv.production? # => false
+# LuckyEnv.test? # => false
+# ```
+#
+# New environments can be added using the `LuckyEnv.add_env` macro.
+#
+# Example:
+# ```
+# LuckyEnv.add_env :staging
+# LuckyEnv.staging? # => false
+# ```
+#
+# To determine whether or not a `LuckyTask` is currently running, you can use
+# the `LuckyEnv.task?` predicate.
+#
+# Example:
+# ```
+# LuckyEnv.task? # => false
+# ```
+
+# Add a staging environment.
+# LuckyEnv.add_env :staging