DeforaNetworks/corteza
DeforaNetworks/corteza
3
0
Fork 0
Code

README file with setup instructions, first draft

Browse Source
This commit is contained in:
Denis Arh 2018-07-12 17:40:43 +02:00
parent fca62c8f5f
commit bdd14dd4d7
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md Normal file
View File

@ -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..)