This repo aims to get you up to speed with creating a Universal Profile on the LUKSO blockchain programmatically and reading data from it.

• Node.js

(back to top)

These examples are very straightforward and all can be run simply with node. We do need to do some minimal setup first though.

This is an example of how to list things you need to use the software and how to install them.

• nvm

  We will be changing our node version for some examples so we will be using nvm. If you do not have it set up take a look here. This will also ensure you have node.js and npm available.

1. Clone the repo

   git clone https://github.com/biancabuzea200/createUP

2. Install NPM packages

   npm install

3. If you have an UP address or Wallet for LUKSO testnet already you can enter them in the .env

   MY_PRIVATE_KEY=
   MY_PUPLIC_KEY=
   MY_UP_ADDRESS=

4. Install the libraries

   npm install @lukso/lsp-factory.js
   npm install web3

(back to top)

This repo goes over some simple examples that you can build on.

For more examples, please refer to the Documentation

1. Navigate to the directory you are interested in, both the ethers and web3.js examples are equivalent.

2. Follow any additional instructions left as comments in each file. The normal order to follow is generateKeys.js -> deployUP.js -> readProfileData.js since this order generates all values needed for subsequent examples.

3. Each example can be run simply with

   node [filepath]/filename.js

4. Make sure to add any newly generated variables to the .env before proceeding to the next example.

   MY_PRIVATE_KEY=
   MY_PUPLIC_KEY=
   MY_UP_ADDRESS=

(back to top)

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. Fork 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)

Bianca Buzea - @buzea200

Project Link: https://github.com/biancabuzea200/createUP

(back to top)