taia-x

NFT-based Sharing Platform for Digital Twin Data on Tezos – a Project with GAIA-X
Explore the docs »

View Demo · Report Bug · Request Feature

Built With

• Vue.js
• Tezos
• Github Actions
• TzKT
• DipDup
• Hasura
• Zokrates

(back to top)

Getting Started

How to set up your project locally.

Prerequisites

To run the project locally you need to have install node.js and Docker

Installation (Sandbox)

1. In the ./contracts directory run:

$ yarn install

2. Rename the .env.template in ./contracts to .env file. The file should include the following data.

ALICE_SECRET=edsk3QoqBuvdamxouPhin7swCvkQNgq4jP5KZPbwWNnwdZpSpJiEbq
JON=jon,edpkuTWU5vkNqfFXSAJuZNVa4gAdF6iU3tZongtkgesoytne2YcqVj,tz1ggvpTMyxX5QVYqbpLVmNGCsgDpDyUMawq,unencrypted:edsk3Un2TGaZYUL1gCDPyUvkYvtxznkmZwfa4fdcjdWrne2kyvd3Lj
LAURA=laura,edpkv2PkEkoaYN9KP769GrFgshMoVn8cvHUuYVUkogxiqZMctxPbB8,tz1TUEs5dubGJoCkvSK11zFqTWU9jh6cV8kb,unencrypted:edsk3VdieyzxcsjFRxApVvLk8LQmQELiuJtGrww27WHamxF83dZwyY
MAGGY=maggy,edpkv8V18vjq3HjYXVtHHtiUB6VBkQBUVmQK4zkHKtZGHLQKagGKa7,tz1fekugemWNMQKcLjxv7YghhyDHwPqd1bVF,unencrypted:edsk3W5FsSG9GMWJNL2nPYJd5NNN8rtikT5Nq3hiJf9NGjDSZW8cco
SOURCE_FILE=/opt/taia-x/contracts/contracts/src/taia_x_main.mligo
OUTPUT_FILE=/opt/taia-x/contracts/contracts/out/taia_x_main.tz
ENTRY_POINT=main

3. In the ./contracts folder compile and run the sandbox via:

$ docker compose up

4. In the ./contracts folder deploy the contract to the sandbox via:

$ yarn run deploy:sandbox

5. Copy the contract address from the console output and assign it to VUE_APP_CONTRACT_ADDRESS in ./frontend/.env.template and rename the file to .env.

6. Rename the .env.template in ./dipdup to .env file and assign the contract address to CONTRACT_ADDRESS.

7. In the ./ipfs folder run the ipfs cluster:

See here how to fix CORS error if it happens, when minting a token.

$ docker compose up

8. Rename the .env.template in ./backend do .env and run the backend:

$ docker compose up

9. In the ./tzkt folder run the tzkt indexer:

$ docker compose up

10. In the ./dipdup folder build and run the selective contract indexer:

$ docker compose build
$ docker compose up

11. In the ./frontend folder build and run taia-x:

$ docker compose build
$ docker compose up

or run without docker via npm run serve

12. Stop all containers by running docker compose down in the respective folders.

(back to top)

Wallet Setup (Sandbox)

1. Create a new Network for your local Sandbox with a local RPC endpoint. Set the RPC-Url to http://localhost:20000 and the name to an arbitrary name.

2. Import all accounts from the .env file in ./contracts by it's private key, which starts with edsk.... The .env includes 4 predefined users:

• ALICE
• MAGGY
• JON
• LAURA

(back to top)

Usage

Show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Running Github Actions locally

Install act following one of the options in the docs

To see the github actions available:

act -l

To run a specific action:

act -j GITHUB_ACTION_NAME

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Pull the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/taia-x/taia-x

(back to top)