DrawNFT.io is a platform built with TypeScript that allows users to create their own NFTs by drawing their own images and selling them on the open market.
We welcome all contributions to DrawNFT.io! Whether you're a seasoned developer or just starting out, there's a place for you in this project. Here's how to get started:
- Fork the repository and clone it locally
- Install dependencies with
npm install - Compile and deploy contracts with
npm run test - Start the development server with
npm run dev
- Create a new branch for your changes
- Make your changes and test them thoroughly
- Submit a pull request to the
stagingbranch
We use the staging branch to test new changes before they are merged into the main branch. After testing, the staging branch will be merged into the main branch.
We expect all contributors to adhere to our Code of Conduct.
To set up the project locally, follow these steps:
Run npm install to install all required dependencies.
Run npm run test to compile and deploy all contracts to a local test network.
Run npm run dev to start the development server and begin working on the project.
We have both Solidity and JavaScript tests in place to ensure the integrity of the project. To run these tests, follow these steps:
Run npx hardhat test to run all Solidity tests in the hardhat directory.
Run make test to run all JavaScript tests.
To deploy the project to a live network, follow these steps:
Make sure you have a wallet and some Ether in it for gas fees.
Run npm run migrate --network goerli to deploy the project to the Rinkeby test network.
Run npm run migrate --network mainnet to deploy the project to the main Ethereum network.
This project is licensed under the MIT License - see the LICENSE file for details.
Thanks to OpenZeppelin for their solidity contracts and OpenSea for the NFT marketplace platform.