0xMiden / 0xMiden/project-template
Long-term project layout
- Dominant language
- Rust
- Stars
- 0
- Forks
- 10
- Avg merge
- 8d 16h
- Merged PRs (30d)
- 1
Description
Just linking to the discussed on how the template should look like long-term: https://github.com/0xMiden/compiler/discussions/646
I think the latest proposal was for something like this:
```
├── .miden # holds files for the Rust client
├── contracts # account components, note and tx scripts go here (each contract as individual crate)
│ ├── target/packages/ # Holds the .masp package files (contains a sub directory for both release and debug)
├── scripts # deployment and other scripts
├── tests # all testing logic for contracts
├── Cargo.toml
├── README.md # contains instructions on how to work within the workspace
├── miden-project.toml # Workspace configuration, profiles, etc...
└── .gitignore # ignores target from pushing to github
```
While not a part of the default template, I think we should also recommend that people use `crates` and `bin` directories for business logic libraries and any binaries (e.g., front-end server) written in Rust.
Contributor guide
Assessment
This issue has not been assessed yet.