Welcome to the NFT Collection Checker project! 🎨 This project consists of a frontend extension and a backend server that allows you to check NFT collections. 🚀 Whether you're a developer or an NFT enthusiast, this tool makes it easy to explore the world of NFTs! 👾
Make sure you have the following installed:
- Node.js (v14 or higher) 🌐
- npm (v6 or higher) 📦
-
Navigate to the Frontend Directory:
cd nft-extension -
Install Dependencies:
npm install
-
Build the Extension:
npm run build
This will create a
distdirectory containing the built extension files. 🎉 -
Load the Extension in Your Browser 🌍
- Open your browser and go to
chrome://extensions/. - Enable Developer mode in the top-right corner.
- Click "Load unpacked" and select the
distdirectory from thenft-extensionfolder. 🔌
- Open your browser and go to
To run the frontend in development mode:
npm run devThis will start a development server, and you can view the extension in your browser! 🌐👀
- Node.js (v14 or higher) 🌐
- npm (v6 or higher) 📦
-
Navigate to the Backend Directory:
cd backend -
Install Dependencies:
npm install
-
Set Up Environment Variables:
- Rename
.env.exampleto.env. - Open the
.envfile and paste your Alchemy API key:
alchemy_api="your_alchemy_api_key_here"
🔑
- Rename
To start the backend server:
nodemon index.jsindex.js
The server will start and listen on the default port (usually 3000). 🌐 You can now interact with the backend API! 🚀
---
## 🚀 **Running the Project** 🚀
1. **Start the Backend Server**: Follow the instructions in the Backend Setup section. 🖥️
2. **Load the Frontend Extension**: Follow the instructions in the Frontend Setup section. 🔧
3. **Interact with the NFT Collection Checker**: Use the extension to interact with the backend and check NFT collections! 🎨
**Ensure the backend server is running** for the extension to work correctly. ✅
---
## 💻 **Contributing** 💻
We welcome contributions to this project! 🎉 Here’s how you can help make this tool even better:
1. **Fork the repository** 🍴
2. **Create a new branch**:
```bash
git checkout -b feature/YourFeatureName
- Commit your changes:
git commit -m 'Add some feature' - Push to the branch:
git push origin feature/YourFeatureName
- Open a pull request 🚀
Let’s build something amazing together! 💥
This project is licensed under the MIT License. Check the LICENSE file for more details. 📄
✨ Thank you for using the NFT Collection Checker! ✨
If you have any questions or need further assistance, feel free to open an issue or contact the maintainers! 🙌
Happy coding, and may the NFTs be with you! 💎🚀
Hope this adds a bit of sparkle to your project! 😄