From bdd14dd4d7923a30e1d0eed89dc0f58cc5835604 Mon Sep 17 00:00:00 2001 From: Denis Arh Date: Thu, 12 Jul 2018 17:40:43 +0200 Subject: [PATCH] README file with setup instructions, first draft --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..132e0d720 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Crust + +@todo What is Crust + +## Contributing + +### Setup + +Copy `.env.example` to `.env` and make proper modifications for your +local environment. + +An access to a (local) instance of MySQL must be available. +Configure access to your database with `SAM_DB_DSN`. + +@todo how to setup crust database + +### Running in local environment for development + +Everything should be set and ready to run with `make realize`. This +utilizes realize tool that monitors codebase for changes and restarts +api http server for every file change. It is not 100% so it needs help +(manual restart) in certain cases (new files added, changes in non .go files etc..)