Draupnir is a magical ring that symbolizes prosperity and abundance. Every ninth night, Draupnir would produce eight new rings of the same size and weight, adding to Odin’s wealth and power. This magical ring adds to the allure of Odin’s arsenal and the mythology that surrounds it.

In the same spirit, this project adds to Odin's wealth and power by scaffolding Odin projects.

This project is part of the Odin's Arsenal.

Download draupnir templates with a quick curl command. Ensure to download the tar.gz version to preserve file permissions.

$ curl -L https://github.com/odin-arsenal/draupnir/archive/refs/heads/main.tar.gz -o templates.tar.gz

Untar the file and rename the template directory of your liking. You can remove the other files and directories.

$ tar –xvzf templates.tar.gz
$ mv draupnir-main/minimal-template my-project
$ rm -rf draupnir-main
$ rm -rf templates.tar.gz
$ cd my-project

The steps above were automated in a bash script. You can download it and put it inside /usr/local/bin

$ curl -L https://github.com/odin-arsenal/draupnir/releases/download/v1.0.0/draupnir.tar.gz -o draupnir.tar.gz
$ tar xvzf draupnir.tar.gz
$ cp draupnir /usr/local/bin

Now you can create templates with draupnir command.

$ draupnir <template> <new-project-directory>

Examples

$ draupnir full my-new-project
$ draupnir minimal my-new-project
$ draupnir blank my-new-project

These templates have in common the project.odin file and the lib directory. These are the core structures that a Draupnir template requires. Following this convention, many tools can have a common standard and help the community understand quicker and better Odin codebases. For example the Gungnir tool can assume the codebase contains at minimum a project.odin file and a lib directory and start searching for files to document inside the lib directory. This convention simplifies many decisions and make tools more thoughtful and friendly.

Extensive documentation can be found at https://odin-arsenal.github.io/draupnir/

• BSD-3

Made with ♥ by Ninjas.cl .