Skip to content

Latest commit

 

History

History
115 lines (74 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

115 lines (74 loc) · 3.45 KB

Contributing to NFTic-Marketplace - Your lovely nft marketplace

We welcome your contributions to NFTic-Marketplace! By contributing to this project, you help us make it better and empower creative minds worldwide. Please take a moment to read and follow this guide to ensure a smooth contribution process.

Table of Contents

Getting Started

Before you start contributing to NFTic-Marketplace, make sure you have the necessary tools and configurations in place.

Prerequisites

Installation

  1. Fork the repository: Click the "Fork" button in the upper right corner of this repository's page.

  2. Clone your fork: In your terminal, use the following command to clone your forked repository:

    git clone https://github.com/your-username/NFTic-Marketplace.git

  3. Navigate to the project directory:

    cd NFTic-Marketplace
cd client or cd contracts

  4. Install dependencies:

    npm install 

     npm install --force

Setting Up Environment Variables

To configure NFTic-Marketplace, you need to set up environment variables. We use a .env file to manage these variables. Follow these steps:

  1. Create a .env file: In the project root directory, create a file named .env.

  2. Add environment variables: Add the required environment variables to your .env file.

  3. Add comments (important!): When adding environment variables, it's crucial to provide comments explaining their purpose and any specific configuration details. This helps other developers understand their usage.

Here's an example of how to format your .env file:

#Client File ENV Values

WEB3PRODUCTID="your-secret"
NFTSTORAGE="your-secret"
ADDRESS_DEPLOYED_TO="your-secret"
SEP_URL="your-secret"
APOLLO_KEY="your-secret"
ABI="your-secret"

#Contract File ENV Values

SEP_URL="your-secret"
PRIVATE_KEY="your-secret"

Development Guidelines

Code Structure

  • Follow best practices.
  • Maintain a clean and organized code structure.
  • Use meaningful variable and function names.

Submitting Changes

  1. Create a new branch: Before making changes, create a new branch with a descriptive name:

    git checkout -b feature-name

  2. Make your changes: Write your code and commit your changes frequently with clear and concise commit messages.

  3. Push your changes: Push your branch to your fork on GitHub:

    git push origin feature-name

  4. Create a pull request: Go to the main NFTic-Marketplace repository on GitHub and create a pull request from your forked branch. Describe your changes and provide context.

  5. Review and collaboration: Participate in the review process, respond to feedback, and collaborate with other contributors to ensure your changes align with project goals.

Contact

Have questions or need assistance? Reach out to us: