#Getting started
#Step 1 - Installation
Gemforge is written in Node.js and works on all the platforms that Node runs on.
Node v16 or above is required. We recommend using nvm to manage different Node versions on your machine.
It's best to install Gemforge globally in your Node environment, depending on which package manager you use:
At this point you should be able to run the gemforge
command:
#Step 2 - Project setup
Gemforge provides example projects to get you started.
These can be cloned and setup in an empty folder using the scaffold command:
If you have an existing Diamond Standard project then you can use the init command to create a Gemforge configuration file.
The gemforge.config.cjs
file will have been created in the current folder. You will probably need to edit this file to customize it for your project.
Note: Gemforge assumes that your project uses the diamond-2-hardhat reference repository for the core Diamond Standard libraries. It also assumes that the core facets are part of your diamond.
#Step 3 - Build contracts
To generate all necessary Diamond code and compile your project inside the project folder:
#Step 4 - Deploy contracts
Assuming a local test node is running at http://localhost:8545, use the following to deploy your Diamond code and facets to it:
At this point you've just built and deployed a Diamond Standard project to your local test node using Gemforge!