https://github.com/rohitroy-github/smart-contract-snippets

A project by to showcase quick solidity smart contract snippets.
https://github.com/rohitroy-github/smart-contract-snippets

ethersjs good-first-issue hacktoberfest hacktoberfest-accepted hacktoberfest2023 hardhat javascript smart-contracts solidity

Last synced: about 1 month ago
JSON representation

A project by to showcase quick solidity smart contract snippets.

• Host: GitHub
• URL: https://github.com/rohitroy-github/smart-contract-snippets
• Owner: rohitroy-github
• Created: 2023-10-01T16:56:04.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2023-10-01T18:57:18.000Z (9 months ago)
• Last Synced: 2024-02-08T21:21:07.068Z (5 months ago)
• Topics: ethersjs, good-first-issue, hacktoberfest, hacktoberfest-accepted, hacktoberfest2023, hardhat, javascript, smart-contracts, solidity
• Language: JavaScript
• Homepage:
• Size: 217 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Lists

• awesome-hacktoberfest-2023 - Smart Contract Snippets

README

        
# Smart Contract Snippets

This project is to showcase quick solidity smart contract snippets for beginners to start working on solidity language or to take references from. 

## Description

This repository contains a collection of simple Solidity smart contracts implemented using the [Hardhat](https://hardhat.org/) development environment. The goal of this project is to provide concise examples of various Solidity contracts for educational purposes and quick reference.

## Getting Started

To get started with this project, you should have Node.js and npm (Node Package Manager) installed on your machine.

1. Clone this repository to your local machine:

   ```bash

   git clone https://github.com/your-username/smart-contract-snippets.git

   ```

2. Change into the project directory:

   ```bash

   cd hardhat-simple-storage-fcc

   ```

   

3. Install the project dependencies:

   ```bash

   npm install

   ```

   

## Usage

1. Running Tests

   You can run the provided tests for the Solidity contracts using the following command:

   ```bash

   npx hardhat test

   ```

   

2. Compiling Contracts

   To compile the Solidity contracts in the contracts/ directory, use the following command:

   ```bash

   npx hardhat compile 

   ```

3. Deploying Contracts / Running Deploy Scripts 

   You can deploy contracts to a local Hardhat network or a live Ethereum network. Modify the deployment script in scripts/deploy.js as needed and then use the following command to deploy:

  ```bash

   npx hardhat run .\scripts\ --network 

   ```

   For running on Loccalhost : 

  ```bash

   npx hardhat run .\scripts\ --network localhost

   ```

### Author

Rohit Roy

### Conclusions

This repository is open to contributions. You can add a solidity code snippet and a test for that contract using the given setup (Hardhat + EthersJS). Once everything is checked on your local setup, you can make a PR to my repository and I'll merge it into the main branch after a thorough review.