| 1 |
# MNW Server |
| 2 |
|
| 3 |
Rust web server for [makenot.work](https://makenot.work), a fair creator platform with 0% platform fees. |
| 4 |
|
| 5 |
Built with Axum, SQLx (PostgreSQL), and Askama templates. |
| 6 |
|
| 7 |
## Documentation |
| 8 |
|
| 9 |
- **Architecture:** `docs/architecture.md` |
| 10 |
- **Contributing:** `CONTRIBUTING.md` |
| 11 |
- **Deployment:** through Sando; see `../sando/deploy/README.md` |
| 12 |
- **Schema:** `docs/schema.md` |
| 13 |
- **Troubleshooting:** `docs/troubleshooting.md` |
| 14 |
|
| 15 |
## Quick start |
| 16 |
|
| 17 |
```sh |
| 18 |
cargo run # development server |
| 19 |
cargo test # run test suite |
| 20 |
cargo clippy # lint |
| 21 |
``` |
| 22 |
|
| 23 |
See `CONTRIBUTING.md` for coding patterns, macros, and conventions. |
| 24 |
|
| 25 |
## Contributing |
| 26 |
|
| 27 |
This project is licensed under PolyForm Noncommercial 1.0.0. Make Creative, LLC owns |
| 28 |
the codebase and needs to hold clear title to all of it, so contributions work a |
| 29 |
little differently here than on a permissively licensed project. |
| 30 |
|
| 31 |
**Found a bug, or something small and obviously wrong?** Open a bug report rather |
| 32 |
than sending a patch. A clear report of what you did, what happened, and what you |
| 33 |
expected is worth more to us than a diff, and it saves you the paperwork below. |
| 34 |
|
| 35 |
**Want to build something substantial?** Write to info@makenot.work first. We are |
| 36 |
open to paying for contributions that matter, and we would rather agree on scope and |
| 37 |
terms before you spend your evenings on it than after. |
| 38 |
|
| 39 |
**Sending code directly?** Any code you submit is covered by the Contributor License |
| 40 |
Agreement in `CLA.md`, which assigns copyright in the contribution to Make Creative, |
| 41 |
LLC. Read it before you send anything. Add these lines to your commit message to |
| 42 |
record that you accept it: |
| 43 |
|
| 44 |
Make-Creative-CLA: 1.0.0 |
| 45 |
Signed-off-by: Your Name <your@email> |
| 46 |
|
| 47 |
We may decline a contribution for any reason, including that it is not something we |
| 48 |
want to maintain. |
| 49 |
|
| 50 |
|