Skip to content

Commit

Permalink
CU-864drcjjf - CR - removed hello_world_template folder, switched bul…
Browse files Browse the repository at this point in the history
…let format to file tree, and added a better description on how to install the packages
luc10921 committed Jun 20, 2023
1 parent 9b25a71 commit ac559a7
Showing 6 changed files with 15 additions and 10 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -2,10 +2,18 @@

A [Neo3-boa](https://github.com/CityOfZion/neo3-boa) project template.

Here, you'll find folders that contains dapp templates, inside each folder there will be a:
- folder with the smart contracts needed to program the dapp;
- folder with unit tests to test the methods of the smart contract;
- .neo-express file to run a [Neo-Express](https://github.com/neo-project/neo-express#neo-express-and-neo-trace)
instance;
- requirements.txt file that has the python packages needed to compile the smart contract and run the unit tests;
- README.md with a brief explanation of the dapp.
Start by installing the required packages inside `requirements.txt` using `pip install -r requirements.txt`. We
recommend creating a virtual environment to isolate your Python environment.

## Folder Structure:
```
├── smart_contracts - This folder contains all smart contracts for this template.
│ └── hello_world.py
├── unit_tests - This folder contains a testcase subclassing unittest.TestCase to test the smart contracts.
│ └── test_hello_world.py
├── venv - A venv folder to keep your packages isolated from your base environment.
├── .gitignore - Will ignore Python and Neo3-boa autogenerated files, and IDE folders.
├── default.neo-express - Neo-Express blockchain network instance file.
├── README.md
└── requirements.txt - Contains the name of the python packages needed to compile the smart contract and run the unit tests.
```
File renamed without changes.
3 changes: 0 additions & 3 deletions hello_world_template/README.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit ac559a7

Please sign in to comment.