|
1 | | -WIP, see https://github.com/gnolang/repo-template/issues/1 |
| 1 | +# Gno Project Template |
| 2 | + |
| 3 | +This repository serves as a template for starting Gno projects with best |
| 4 | +practices and proper tooling baked in. It helps contributors or teams quickly |
| 5 | +scaffold a real-world Gno setup. |
| 6 | + |
| 7 | +## Features |
| 8 | + |
| 9 | +- Handles installing Go & Gno dependencies |
| 10 | +- Runs gnodev with a minimal default realm |
| 11 | +- Includes test and lint commangids |
| 12 | +- Integrated with GitHub Actions CI workflow |
| 13 | +- Supports both p/ and r/ structure |
| 14 | +- Configured for external dependencies |
| 15 | +- Editor configurations included |
| 16 | + |
| 17 | +## Prerequisites |
| 18 | + |
| 19 | +- Go 1.21 or later |
| 20 | +- Gno development environment |
| 21 | + |
| 22 | +## Getting Started |
| 23 | + |
| 24 | +1. Clone this repository: |
| 25 | + ```bash |
| 26 | + git clone https://github.com/gnolang/repo-template.git |
| 27 | + cd repo-template |
| 28 | + ``` |
| 29 | + |
| 30 | +2. Install dependencies: |
| 31 | + ```bash |
| 32 | + make deps |
| 33 | + ``` |
| 34 | + |
| 35 | +3. Run tests: |
| 36 | + ```bash |
| 37 | + make test |
| 38 | + ``` |
| 39 | + |
| 40 | +4. Start the development node: |
| 41 | + ```bash |
| 42 | + make dev |
| 43 | + ``` |
| 44 | + |
| 45 | +## Project Structure |
| 46 | + |
| 47 | +- `p/` - Contains packages that can be imported by other Gno code |
| 48 | +- `r/` - Contains realms (smart contracts) |
| 49 | +- `.github/workflows/` - CI/CD configuration |
| 50 | +- `Makefile` - Common development commands |
| 51 | + |
| 52 | +## Development |
| 53 | + |
| 54 | +- `make test` - Run all tests |
| 55 | +- `make lint` - Run linter |
| 56 | +- `make clean` - Clean build artifacts |
| 57 | +- `make deps` - Install dependencies |
| 58 | +- `make dev` - Run development node |
| 59 | + |
| 60 | +## License |
| 61 | + |
| 62 | +MIT |
0 commit comments