Learn-NEAR / NCD.L1.sample--meme-museum

The Meme Museum

This repository includes contracts for NEAR Academy

⚠️ Warning

Any content produced by NEAR, or developer resources that NEAR provides, are for educational and inspiration purposes only. NEAR does not encourage, induce or sanction the deployment of any such applications in violation of applicable laws or regulations.

Usage

Getting started

1. clone this repo to a local folder
2. run yarn
3. run yarn test

Top-level yarn commands

• run yarn test to run all tests
  • (!) be sure to run yarn build:release at least once before:
    • run yarn test:unit to run only unit tests
    • run yarn test:simulate to run only simulation tests
• run yarn build to quickly verify build status
• run yarn clean to clean up build folder

Other documentation

• Meme contract and test documentation

  • see /src/meme/README for Meme interface
  • see /src/meme/__tests__/README for Meme unit testing details

• Museum contract and test documentation

  • see /src/museum/README for Museum interface
  • see /src/museum/__tests__/README for Museum unit testing details

• simulation tests

  • see /simulation/README for simulation testing

The file system

Please note that boilerplate project configuration files have been ommitted from the following lists for simplicity.

Contracts and Unit Tests

src
├── meme                          <-- Meme contract
│   ├── README.md
│   ├── __tests__
│   │   ├── README.md
│   │   └── index.unit.spec.ts
│   └── assembly
│       ├── index.ts
│       └── models.ts
├── museum                        <-- Museum contract
│   ├── README.md
│   ├── __tests__
│   │   ├── README.md
│   │   └── index.unit.spec.ts
│   └── assembly
│       ├── index.ts
│       └── models.ts
└── utils.ts                      <-- shared contract code

Simulation Tests

simulation                        <-- simulation tests
├── Cargo.toml
├── README.md
└── src
    ├── lib.rs
    ├── meme.rs
    └── museum.rs