Reorganize project directories (#783)

## Type of change

<!--Delete points that do not apply-->

- Improvement (refactoring, restructuring repository, cleaning tech
debt, ...)

## Changes

The following changes have been made:

Changes the project structure for all projects to:
```
My_app
├── src/
│   └────── main.tsx
├── app-contract
│   ├────── src/main.sw
│   └────── tests/harness.rs
├── package.json
├── index.html
├── README.md
└── SPECIFICATION.md
```

This should allow for quicker access to the project's source code and
not be buried in a million directories.

## Notes

- Some projects such as TicTacToe/NFT have been removed from
"games"/"native-assets" and moved into the parent directory
- This may break any other open pull requests that depend on this
project structure
- Empty UI folders have been removed

---------

Co-authored-by: Matt Auer <mattauer@umich.edu>

native-assets/NFT/project/Cargo.toml → .devops/.template/Cargo.toml

@@ -1,5 +1,6 @@
 [workspace]
 resolver = "2"
 members = [
-    "./contracts/NFT-contract",
+    "./template-contract",
 ]
+

.devops/.template/Forc.toml

@@ -0,0 +1,2 @@
+[workspace]
+members = ["./template-contract"]

.devops/.template/README.md

@@ -21,7 +21,7 @@
 
 TODO: A summary of the application should be written here.
 
-More information about the contract can be found [here](./project/SPECIFICATION.md) and for the user interface [here](./ui/SPECIFICATION.md).
+More information about the contract can be found [here](./SPECIFICATION.md).
 
 ## Project structure
 
@@ -31,31 +31,25 @@ The project consists of a smart contract.
 
 ```sh
 Template
-├── project
-│   ├── contracts
-│   │   └── template-contract
-│   │       ├── src/main.sw
-│   │       └── tests/harness.rs
-│   ├── libraries
-│   ├── predicates
-│   ├── scripts
-│   ├── README.md
-│   └── SPECIFICATION.md
-├── ui
-│   ├── README.md
-│   └── SPECIFICATION.md
-└── README.md
+├── template-contract
+│   ├── src/main.sw
+│   └── tests/harness.rs
+├── libraries
+├── predicates
+├── scripts
+├── README.md
+└── SPECIFICATION.md
 ```
 
 ## Running the project
 
 ### User interface
 
-TODO: The user interface does not currently exist therefore its [README.md](ui/README.md) and [SPECIFICATION.md](ui/SPECIFICATION.md) are empty.
+TODO: The user interface does not currently exist.
 
 ### Project
 
-In order to run the subsequent commands change into the following directory `/path/to/Template/project/<here>`.
+In order to run the subsequent commands change into the following directory `/path/to/Template/<here>`.
 
 #### Program compilation
 

.devops/.template/project/contracts/template-contract/tests/utils/setup.rs → .devops/.template/template-contract/tests/utils/setup.rs

@@ -2,7 +2,7 @@ use fuels::prelude::*;
 
 abigen!(Contract(
     name = "Template",
-    abi = "./contracts/template-contract/out/debug/template-contract-abi.json"
+    abi = "./template-contract/out/debug/template-contract-abi.json"
 ));
 
 const TEMPLATE_CONTRACT_BINARY_PATH: &str = "./out/debug/template-contract.bin";

.devops/aurora/apps.txt

@@ -2,15 +2,15 @@ AMM
 DAO
 OTC-swap-predicate
 airdrop
-auctions/english-auction
+english-auction
 counter-script
 escrow
 fundraiser
-games/TicTacToe
+TicTacToe
 multisig-wallet
 name-registry
-native-assets/NFT
-native-assets/native-asset
-native-assets/fractional-NFT
+NFT
+native-asset
+fractional-NFT
 oracle
 timelock

.devops/aurora/src/utils.rs

@@ -41,7 +41,7 @@ pub(crate) fn repo_root() -> String {
 
 pub(crate) fn project_path(app: String, root: String) -> anyhow::Result<PathBuf> {
     Ok(
-        std::fs::canonicalize(format!("{}/{}/project", root, app)).map_err(|error| {
+        std::fs::canonicalize(format!("{}/{}/", root, app)).map_err(|error| {
             anyhow!(
                 "Failed to canonicalize path to project for app '{}': {}",
                 app,

.github/workflows/ci.yml

@@ -42,17 +42,17 @@ jobs:
           [
             "airdrop",
             "AMM",
-            "auctions/english-auction",
+            "english-auction",
             "counter-script",
             "DAO",
             "escrow",
             "fundraiser",
-            "games/TicTacToe",
+            "TicTacToe",
             "multisig-wallet",
             "name-registry",
-            "native-assets/NFT",
-            "native-assets/native-asset",
-            "native-assets/fractional-NFT",
+            "NFT",
+            "native-asset",
+            "fractional-NFT",
             "oracle",
             "OTC-swap-predicate",
             ".devops/.template",
@@ -80,37 +80,37 @@ jobs:
 
       - name: Check Sway formatting
         run: |
-          cd ${{ matrix.project }}/project
+          cd ${{ matrix.project }}
           forc fmt --check
 
       - name: Check Rust formatting
         run: |
-          cd ${{ matrix.project }}/project
+          cd ${{ matrix.project }}
           cargo fmt --verbose --check
 
       - name: Build Sway
         run: |
-          cd ${{ matrix.project }}/project
+          cd ${{ matrix.project }}
           forc build --locked
 
       - name: Build Rust files
         run: |
-          cd ${{ matrix.project }}/project
+          cd ${{ matrix.project }}
           cargo build --locked
 
       - name: Check Clippy Linter
         run: |
-          cd ${{ matrix.project }}/project
+          cd ${{ matrix.project }}
           cargo clippy --all-features --all-targets -- -D warnings
 
       - name: Run Rust tests
         run: |
-          cd ${{ matrix.project }}/project
+          cd ${{ matrix.project }}
           cargo test --locked
 
       - name: Run Sway tests
         run: |
-          cd ${{ matrix.project }}/project
+          cd ${{ matrix.project }}
           forc test
 
   contributing-book:

AMM/.gitignore

@@ -1,7 +1,2 @@
 target
-project/contracts/AMM-contract/out
-project/contracts/exchange-contract/out
-project/contracts/test-artifacts/malicious-implementation/out
-project/scripts/atomic-add-liquidity/out
-project/scripts/swap-exact-input/out
-project/scripts/swap-exact-output/out
+out

AMM/project/contracts/AMM-contract/Cargo.toml → AMM/AMM-contract/Cargo.toml

@@ -7,7 +7,7 @@ license = "Apache-2.0"
 
 [dependencies]
 fuels = { version = "0.55.0", features = ["fuel-core-lib"] }
-test-utils = { path = "../../test-utils" }
+test-utils = { path = "../test-utils" }
 tokio = { version = "1.21.0", features = ["rt", "macros"] }
 
 [[test]]

AMM/project/contracts/AMM-contract/Forc.toml → AMM/AMM-contract/Forc.toml

@@ -5,4 +5,4 @@ license = "Apache-2.0"
 name = "AMM-contract"
 
 [dependencies]
-libraries = { path = "../../libraries" }
+libraries = { path = "../libraries" }

AMM/Cargo.toml

@@ -0,0 +1,10 @@
+[workspace]
+resolver = "2"
+members = [
+    "./AMM-contract",
+    "./exchange-contract",
+    "./atomic-add-liquidity",
+    "./swap-exact-input",
+    "./swap-exact-output",
+    "./test-utils",
+]

AMM/Forc.toml

@@ -0,0 +1,9 @@
+[workspace]
+members = [
+  "./AMM-contract",
+  "./exchange-contract",
+  "./test-utils/test-artifacts/malicious-implementation",
+  "./atomic-add-liquidity",
+  "./swap-exact-input",
+  "./swap-exact-output",
+]

AMM/README.md

@@ -42,24 +42,17 @@ The contracts are designed to
 
 ```sh
 AMM
-├── project
-│   ├── contracts
-│   │   ├── AMM-contract
-│   │   └── exchange-contract
-│   ├── libraries
-│   │   └── src/interface.sw
-│   ├── scripts
-│   │   ├── atomic-add-liquidity
-│   │   ├── swap-exact-input
-│   │   └── swap-exact-output
-|   ├── test-utils
-|   |   └── src/lib.rs
-|   ├── README.md
-│   └── SPECIFICATION.md
-├── ui
-│   ├── README.md
-│   └── SPECIFICATION.md
-└─── README.md
+├── AMM-contract
+├── exchange-contract
+├── libraries
+│   └── src/interface.sw
+├── atomic-add-liquidity
+├── swap-exact-input
+└── swap-exact-output
+├── test-utils
+    └── src/lib.rs
+├── README.md
+└── SPECIFICATION.md
 ```
 
 All contracts and scripts have the structure:

AMM/project/scripts/atomic-add-liquidity/Cargo.toml → AMM/atomic-add-liquidity/Cargo.toml

@@ -7,7 +7,7 @@ license = "Apache-2.0"
 
 [dev-dependencies]
 fuels = { version = "0.55.0", features = ["fuel-core-lib"] }
-test-utils = { path = "../../test-utils" }
+test-utils = { path = "../test-utils" }
 tokio = { version = "1.12", features = ["rt", "macros"] }
 
 [[test]]

AMM/project/scripts/atomic-add-liquidity/Forc.toml → AMM/atomic-add-liquidity/Forc.toml

@@ -5,4 +5,4 @@ license = "Apache-2.0"
 name = "atomic-add-liquidity"
 
 [dependencies]
-libraries = { path = "../../libraries" }
+libraries = { path = "../libraries" }

AMM/project/contracts/exchange-contract/Cargo.toml → AMM/exchange-contract/Cargo.toml

@@ -7,7 +7,7 @@ license = "Apache-2.0"
 
 [dependencies]
 fuels = { version = "0.55.0", features = ["fuel-core-lib"] }
-test-utils = { path = "../../test-utils" }
+test-utils = { path = "../test-utils" }
 tokio = { version = "1.21.0", features = ["rt", "macros"] }
 
 [[test]]

AMM/project/contracts/exchange-contract/Forc.toml → AMM/exchange-contract/Forc.toml

@@ -5,4 +5,4 @@ license = "Apache-2.0"
 name = "exchange-contract"
 
 [dependencies]
-libraries = { path = "../../libraries" }
+libraries = { path = "../libraries" }