Upgrade to webpack

.github/CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-akhileshthite@hotmail.com.
+info@buidltools.com.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

.github/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+> Contributions are always welcome!
+
+## Issues
+
+* Do not hesitate and [create a new Issue](https://github.com/buidltools/dscan/issues/new/choose) if you see a bug, room for improvement or simply have a question.
+* Feel free to work on issues that are [not assigned yet](https://github.com/buidltools/dscan/issues?utf8=✓&q=is%3Aissue+is%3Aopen+no%3Aassignee).
+* Do not create a pull request without an issue before discussing the problem.
+
+## Pull Requests
+
+* Make sure your PR comes with its own tests.
+* Always be descriptive in your PR -> add screenshots, explain in detail what improvements you did, or bugs you solved.
+
+## Commits
+
+* Learn more about conventional commits [here](https://www.conventionalcommits.org/en/v1.0.0/).
+
+## Code Style
+
+* Make sure to commit in the same style that we are committing until now on the project.
+* Run `prettier` in each code file.
+
+## Questions
+* Please reach out to us at [email protected].
+
+*Hope to see your username on our list of [contributors](https://github.com/buidltools/dscan/graphs/contributors) 🎉*

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+buidl
+.env

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Akhilesh Thite
+Copyright (c) 2021-2022 BUIDL Tools
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,31 +1,59 @@
 <p align="center">
-    <img align="center" src="/static/assets/logo.png" width="150" height"400"></img>
+    <img align="center" src="/src/img/logo.png" width="150" height="150"></img>
 </p>
 
 <h1 align="center">DScan</h1>
 
 <div align="center">
     <img src="https://img.shields.io/badge/extension-DScan-2C80C1" alt="Platform" />
     <img src="https://img.shields.io/github/v/release/akhileshthite/dscan?color=1FC71F" alt="Release version" />
-    <img src="https://img.shields.io/chrome-web-store/d/idpfgkgogjjgklefnkjdpghkifbjenap?label=active users" alt="Active users">
+    <img src="https://img.shields.io/badge/contributions-welcome-orange.svg?" alt="Contributions welcome">
 </div><br>
 
-DScan allows you to quickly upload images, audio, video, and any type of files (including NFTs and static websites) to [IPFS](https://ipfs.io/) and get a QR code with IPFS links. Later you can share the QR code or [Infura](https://infura.io/) link with everyone for easy and decentralized file sharing.
-For more information you can read this [blog post](https://dev.to/akhileshthite/dscan-decentralized-qr-code-generator-use-web3-for-file-sharing-2lp8). If you have any queries, then follow this [discussion thread](https://github.com/filecoin-project/community/discussions/410).
+DScan allows you to quickly upload images, audio, video, and any type of files (including NFTs and static websites) to [IPFS](https://ipfs.io/) and get a decentralized QR code with IPFS links. Later you can share the QR code or hosted [Infura](https://infura.io/) link with everyone for easy and decentralized file sharing.<br>
+For more information, you can read this [blog post](https://dev.to/akhileshthite/dscan-decentralized-qr-code-generator-use-web3-for-file-sharing-2lp8). If you have any queries, then follow this [discussion thread](https://github.com/filecoin-project/community/discussions/410).
 
-### Add extension:
-* `Chromium browsers`: [Chrome web store](https://chrome.google.com/webstore/detail/dscan-decentralized-qr-co/idpfgkgogjjgklefnkjdpghkifbjenap)
+## Extension
+| <img src="https://unpkg.com/@browser-logos/chrome/chrome_16x16.png" width="16" height="16"> [Chrome](https://www.google.com/chrome/) \| <img src="https://unpkg.com/@browser-logos/brave/brave_16x16.png" width="16" height="16"> [Brave](https://brave.com/) \| <img src="https://unpkg.com/@browser-logos/opera/opera_16x16.png" width="16" height="16"> [Opera](https://www.opera.com/)  \| <img src="https://unpkg.com/@browser-logos/edge/edge_16x16.png" width="16" height="16"> [Edge](https://www.microsoftedgeinsider.com/) |
+| ------------- |
+| [![Install from Chrome Store](https://ipfs.io/ipfs/QmU4Qm5YEKy5yHmdAgU2fD7PjZLgrYTUUbxTydqG2QK3TT)<br>![](https://img.shields.io/chrome-web-store/users/idpfgkgogjjgklefnkjdpghkifbjenap?label=Chrome%20Web%20Store%20users&style=social)](https://chrome.google.com/webstore/detail/dscan-decentralized-qr-co/idpfgkgogjjgklefnkjdpghkifbjenap) |
 
-### Development setup:
 
-* Download `extension.zip` from this github repository and extract it.
+## Development
+The extension's development code is placed in `/src` folder. manifest.json is in `/public` folder. For webpack settings, follow the `webpack.config.js` file.
 
-* Select `Developer mode` in your browser extensions.
+1. Install dependencies.
 
-* Select `Load unpacked extension` and open the extracted folder.
+```bash
+npm install
+```
 
-### License
-DScan is licensed under the [MIT](https://github.com/AkhileshThite/dscan/blob/main/LICENSE) License.
+2. After development of the extension, run the following command. This will create a `production` build.
+
+```bash
+npm run build
+```
+
+3. Now, the `buidl` will appear in the root directory.
+
+4. Select `Developer mode` in your browser extensions tab.
+
+5. Select `Load unpacked extension` and open the `buidl` folder.
+
+*After every change, run `npm run build` command and it will update `buidl` folder automatically, so you don't have to manualy upload the folder after every change.*
+
+For more information, read the [Webpack docs](https://webpack.js.org/concepts/) and the [Chrome Extension docs](https://developer.chrome.com/docs/extensions/mv3/getstarted/).
+
+## Contribute
+* Thanks for your interest in contributing to DScan. There are many ways you can contribute to the project.
+* To start, take a few minutes to read the [contribution guide](https://github.com/buidltools/dscan/blob/main/.github/CONTRIBUTING.md).
+* We look forward to your [pull requests](https://github.com/buidltools/dscan/pulls) and / or involvement in our [issues page](https://github.com/buidltools/dscan/issues).
+
+
+## License
+DScan is licensed under the [MIT License](https://github.com/buidltools/dscan/blob/main/LICENSE).
+
+
+<hr>
+Don't forget to leave a star ⭐️ ~ <a href="https://twitter.com/buidltools" target="_blank"><img src="https://img.shields.io/twitter/follow/buidltools?style=social" alt="twitter" /></a>
 
-### Support
-Don't forget to leave a star ⭐️.