add contributing.md and lint code

Author: arihantbansal

.eslintrc

@@ -1,12 +1,10 @@
 {
-    "root": true,
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-      "@typescript-eslint"
-    ],
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/eslint-recommended",
-      "plugin:@typescript-eslint/recommended"
-    ]
-  }
+	"root": true,
+	"parser": "@typescript-eslint/parser",
+	"plugins": ["@typescript-eslint"],
+	"extends": [
+		"eslint:recommended",
+		"plugin:@typescript-eslint/eslint-recommended",
+		"plugin:@typescript-eslint/recommended"
+	]
+}

.vscode/settings.json

@@ -58,9 +58,10 @@
 </details>
 
 <!-- ABOUT THE PROJECT -->
+
 ## About The Project
 
-**ATTENTION**: This project is under beta and not ready for production - using it in product is highly discouraged without prior thorough review. 
+**ATTENTION**: This project is under beta and not ready for production - using it in product is highly discouraged without prior thorough review.
 
 ![product-screenshot]
 
@@ -72,27 +73,31 @@ From the chain to use, through the wallet login system, to the React components
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
-
 <!-- GETTING STARTED -->
+
 ## Getting Started
 
 This is an example of how you may give instructions on setting up your project locally.
 To get a local copy up and running follow these simple example steps.
 
 ### **Prerequisites**
 
-* NodeJS
+- NodeJS
 
 To install node go on the [official Node website](https://nodejs.org/en/download/), and download the LTS package for your Operating System.
 
 To verify if NodeJS has been correctly installed on your system, open your terminal and run:
+
 ```sh
 node -v
 ```
+
 and
+
 ```sh
 npm -v
 ```
+
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 ## **Quick Start**
@@ -101,61 +106,67 @@ npm -v
 2. Create a new Alchemy application.
 
 3. In your terminal run:
+
 ```sh
   npx create-web3-dapp
-  ```
+```
 
 4. The first time you'll run this command, it will install the package.
 
 5. Once installed, run the following command again - This will start the DApp creation flow.:
+
 ```sh
     npx create-web3-dapp
-   ```
+```
 
 6. Select the dependencies and components you want to include in your web3 application:
-![product-screenshot-2]
+   ![product-screenshot-2]
 
 7. Navigate to the application folder
+
 ```
 cd my-dapp
 ```
+
 8. Run the application
+
 ```sh
 npm run dev
 ```
+
 9. Go to to <a href="localhost:3000">localhost:3000</a>:
-![product-screenshot]
+   ![product-screenshot]
 
 10. Enjoy Web3.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
-
 <!-- ROADMAP -->
+
 ## **Roadmap**
 
 - [ ] Style localhost landing page + components
 - [ ] Components selection workflow
 - [ ] Write tests
 - [ ] Implement support for new Blockchain development environments:
-    - [ ] Foundry
-    - [ ] Anchor
+  - [ ] Foundry
+  - [ ] Anchor
 - [ ] Add OpenZeppelin Support
 - [ ] Add collection floor price component
 - [ ] Templates selection workflow
-- [ ] Implement GitHub Actions build on push 
+- [ ] Implement GitHub Actions build on push
 - [ ] Review contributions .md
 
-
-
 See the [open issues](https://github.com/eversmile12/create-web3-dapp/issues) for a full list of proposed features (and known issues).
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 ## Open Source
+
 </br>
 
 ### Contributors
+
 <ul>
 <li>Vitto Rivabella - <a href="https://www.linkedin.com/in/vittorio-rivabella/">Linkedin</a> - <a href="https://twitter.com/VittoStack">Twitter</a> - <a href="https://github.com/eversmile12">GitHub</a></li>
 <li>Albert Hu - <a href="https://www.linkedin.com/in/albhu/">Linkedin</a> - <a href="https://twitter.com/thatguyintech">Twitter</a> - <a href="https://github.com/thatguyintech">GitHub</a></li>
@@ -164,6 +175,7 @@ See the [open issues](https://github.com/eversmile12/create-web3-dapp/issues) fo
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 <!-- CONTRIBUTING -->
+
 ### 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**.
@@ -218,17 +230,16 @@ If you have a suggestion that would make this better, please fork the repo and c
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
-
 <!-- LICENSE -->
+
 ## License
 
 Distributed under the MIT License. See `LICENSE.txt` for more information.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
-
-
 <!-- CONTACT -->
+
 ## Contact
 
 Your Name - [@twitter_handle](https://twitter.com/vittostack) - [email protected]
@@ -237,8 +248,8 @@ Project Link: [https://github.com/eversmile12/create-web3-dapp](https://github.c
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
-
 <!-- MARKDOWN LINKS & IMAGES -->
+
 [contributors-shield]: https://img.shields.io/github/contributors/eversmile12/create-web3-dapp.svg?style=for-the-badge
 [contributors-url]: https://github.com/eversmile12/create-web3-dapp/graphs/contributors
 [forks-shield]: https://img.shields.io/github/forks/eversmile12/create-web3-dapp.svg?style=for-the-badge
@@ -250,7 +261,5 @@ Project Link: [https://github.com/eversmile12/create-web3-dapp](https://github.c
 [license-shield]: https://img.shields.io/github/license/eversmile12/create-web3-dapp.svg?style=for-the-badge
 [license-url]: https://github.com/eversmile12/create-web3-dapp/blob/master/LICENSE.txt
 [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
-
-
 [product-screenshot]: images/screenshot.png
 [product-screenshot-2]: images/screenshot_2.png

README.md

@@ -0,0 +1,36 @@
+# Contributing
+
+Contributions are welcome!
+
+1. Check the [ISSUES](https://github.com/Eversmile12/create-web3-dapp/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc). Read every issue to understand what's needed and whether it's something you can help with.
+
+2. Ask other contributors to see if no one has taken the issue yet. If you're interested in tackling such a feature and it's still available, we will assign you to the task.
+
+3. Clone the repo and create your own branch using `git checkout -b your_branch_name`. Remember to use a branch name that describes WHAT you're doing/fixing.
+
+4. Setup your local development environment. Instructions
+
+5. Once your work is done with the local copy of the repo, don't hesitate to open a pull request. We'll gladly revise and push as deemed fit.
+
+6. Feel free to add new issues as you read the code and find inconsistencies and/or possible features that may add up to the website. Follow the labeling standards to make it easier to understand what you're proposing.
+
+7. Document changes and/or issues clearly. Make it easy for everyone involved to understand your ideas/changes.
+
+## Local development
+
+To setup your local dev environment:
+
+```sh
+# Clone the repo
+git clone https://github.com/Eversmile12/create-web3-dapp.git
+
+cd create-web3-dapp
+
+# Install dependencies
+yarn
+
+```
+
+## Creating a pull request
+
+In order to create a pull request for create-web3-dapp, follow the GitHub instructions for [Creating a pull request from a fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). Please link your pull request to an existing issue.

contributing.md

@@ -8,53 +8,62 @@ import { createWriteStream } from "fs";
 import { generateAlchemyURL } from "../utils/generateAlchemyUrl.js";
 
 export const setUpHardhat = (dappInfo: dappInfo) => {
-  const bar2 = new cliProgress.SingleBar(
-    {},
-    cliProgress.Presets.shades_classic
-  );
-  bar2.start(100, 0);
-  bar2.update(50);
-
-  const hardhatTemplate = path.join(process.cwd(), "templates", "hardhat");
-  fse.mkdirSync(path.join(process.cwd(), "backend"));
-  fse.copySync(hardhatTemplate, path.join(process.cwd(), "backend"));
-
-  if (dappInfo.apiKeys) {
-    createEnv(dappInfo.apiKeys, path.join(process.cwd(), "backend"), false);
-  }
-
-  const writeStream = createWriteStream(path.join(process.cwd(), "backend", "hardhat.config.js"))
-  
-  writeStream.write("require('@nomicfoundation/hardhat-toolbox');\n");
-  writeStream.write("require('dotenv').config()\n");
-
-  writeStream.write("// Remove the quotes to get started \n");
-  const modules = {
-    solidity: "0.8.9",
-    networks: {
-      hardhat: {},
-      [dappInfo.chain]: {
-        accounts: "[`0x${process.env.PRIVATE_KEY}`]",
-        url: generateAlchemyURL(dappInfo.chain, dappInfo.apiKeys.alchemy_api_key)
-      }
-    },
-
-  }
-
-  if (dappInfo.isTestnet) {
-    modules.networks[dappInfo.testnet!] = {
-      accounts: "[`0x${process.env.PRIVATE_KEY}`]",
-      url: generateAlchemyURL(dappInfo.testnet, dappInfo.apiKeys.alchemy_api_key)
-    }
-  }
-
-
-
-  writeStream.write(`module.exports = ${JSON.stringify(modules, null, "\t").replace(/"([^"]+)":/g, '$1:')}`)
-  writeStream.close()
-
-
-  bar2.update(100);
-  bar2.stop();
-  console.log(chalk.green("Smart Contract Development Environment copied ✅"));
+	const bar2 = new cliProgress.SingleBar(
+		{},
+		cliProgress.Presets.shades_classic
+	);
+	bar2.start(100, 0);
+	bar2.update(50);
+
+	const hardhatTemplate = path.join(process.cwd(), "templates", "hardhat");
+	fse.mkdirSync(path.join(process.cwd(), "backend"));
+	fse.copySync(hardhatTemplate, path.join(process.cwd(), "backend"));
+
+	if (dappInfo.apiKeys) {
+		createEnv(dappInfo.apiKeys, path.join(process.cwd(), "backend"), false);
+	}
+
+	const writeStream = createWriteStream(
+		path.join(process.cwd(), "backend", "hardhat.config.js")
+	);
+
+	writeStream.write("require('@nomicfoundation/hardhat-toolbox');\n");
+	writeStream.write("require('dotenv').config()\n");
+
+	writeStream.write("// Remove the quotes to get started \n");
+	const modules = {
+		solidity: "0.8.9",
+		networks: {
+			hardhat: {},
+			[dappInfo.chain]: {
+				accounts: "[`0x${process.env.PRIVATE_KEY}`]",
+				url: generateAlchemyURL(
+					dappInfo.chain,
+					dappInfo.apiKeys.alchemy_api_key
+				),
+			},
+		},
+	};
+
+	if (dappInfo.isTestnet) {
+		modules.networks[dappInfo.testnet!] = {
+			accounts: "[`0x${process.env.PRIVATE_KEY}`]",
+			url: generateAlchemyURL(
+				dappInfo.testnet,
+				dappInfo.apiKeys.alchemy_api_key
+			),
+		};
+	}
+
+	writeStream.write(
+		`module.exports = ${JSON.stringify(modules, null, "\t").replace(
+			/"([^"]+)":/g,
+			"$1:"
+		)}`
+	);
+	writeStream.close();
+
+	bar2.update(100);
+	bar2.stop();
+	console.log(chalk.green("Smart Contract Development Environment copied ✅"));
 };