2020-05-17 15:35:06 +00:00
# <img src="doc/logo-display-only.svg" width="50%" style="display: block; margin: 0 auto;" alt="Rakenne" />
2020-05-17 15:08:31 +00:00
2020-05-17 15:38:25 +00:00
Rakenne is a database modeling tool for command line written in Crystal.
2020-05-17 15:38:59 +00:00
For now, It is a toy project to improve author's skills with the language and its various libraries. **It is very early stage and is not supposed to work (yet). Please don't use it in production.** :warning:
2020-05-17 15:08:31 +00:00
2020-05-17 15:37:06 +00:00
Note: _rakenne_ means _structure_ in Finnish.
2020-05-17 15:08:31 +00:00
2020-05-17 15:35:06 +00:00
## Roadmap
2020-05-17 15:08:31 +00:00
2020-05-17 15:43:16 +00:00
* define a DSL for modeling database
2020-05-17 15:35:06 +00:00
* describe entity-relationship diagrams (ERD) using MERISE notation
* describe physical diagrams (PD)
* provide a command-line tool for all operations
* render models into diagrams
2020-05-17 15:08:31 +00:00
* ERD to MERISE MCD diagrams
* ERD to Chen notation diagrams
* PD to MERISE MLD diagrams
2020-05-17 15:35:06 +00:00
* validate model
* convert across different database reprentations
2020-05-17 15:08:31 +00:00
* to convert ERD to PD
* to convert PD to database specific SQL
* to reverse-engineer database-specific SQL to PD
* to reverse-engineer PD to ERD
2020-05-17 15:35:06 +00:00
* support multiple physical models
2020-05-17 15:08:31 +00:00
* sql
* nosql
2020-05-17 15:35:06 +00:00
* support multiple SQL and NoSQL languages
2020-05-17 15:08:31 +00:00
* SQL: postgresql
* SQL: mariadb
* NoSQL: redis
* NoSQL: mongodb
* NoSQL: cassandra CQL
2020-05-17 15:43:16 +00:00
## Contributing
Please read [doc/contributing.md ](doc/contributing.md )
## Authors & contributors
* [Glenn Y. Rolland ](https://github.com/glenux ) - creator and maintainer
## Sponsors
[Vitreous ](https://github.com/glenux/vitreous ) is an independent project whose development and maintenance is made possible thanks to the support of its patrons.
If you wish to join them and support the work of its author, just participate with this link:
**>>> Become a patron or sponsor on Patreon ](https://www.patreon.com/glenux ) <<< **
## License
Vitreous is Copyright © 2020 Glenn ROLLAND. It is free software, and may be redistributed under the terms specified in the LICENSE.txt file.
2020-05-17 15:08:31 +00:00
## References
* https://en.wikipedia.org/wiki/Entity%E2%80%93relationship_model
* https://www.lucidchart.com/pages/er-diagrams
* https://www.youtube.com/watch?v=LR0Ip5Jenbk
