SpandanM110 / Ethpreneur

0 stars 4 forks source link

Ethpreneur 🌐

A decentralized platform for listing companies as NFTs and allowing users to trade company stocks as digital assets.

Overview

Ethpreneur empowers users to create, manage, and trade company shares as NFTs on the blockchain. Built with Next.js, TypeScript, and Thirdweb, it provides a secure and user-friendly interface to interact with decentralized companies, with features like wallet-based authentication, company listings, and NFT shares trading.

Key Features

Tech Stack


Getting Started

Prerequisites

Make sure you have the following installed:

Installation

  1. Clone the repo:

    git clone https://github.com/SpandanM110/ethpreneur.git
    cd ethpreneur
  2. Install dependencies:

    yarn install
  3. Set up environment variables:

    • Create a .env.local file in the root directory.
    • Add your Thirdweb, Ethereum, and other necessary keys:

      NEXT_PUBLIC_THIRDWEB_API_KEY=your_thirdweb_api_key
      NEXT_PUBLIC_INFURA_PROJECT_ID=your_infura_project_id
  4. Start the development server:

    yarn dev

    Open http://localhost:3000 to see the application in action.


How to Contribute

We welcome contributions from everyone! To contribute:

  1. Fork the repository.
  2. Create a new branch for each feature or fix:
    git checkout -b feature/your-feature-name
  3. Make your changes and test thoroughly.
  4. Create a Pull Request and follow the PR template.

Be sure to check out our Code of Conduct before contributing.


Project Structure

Here’s a breakdown of the major folders:

ethpreneur/
β”‚
β”œβ”€β”€ /components/    # Reusable React components
β”œβ”€β”€ /pages/         # Next.js pages and routing
β”œβ”€β”€ /public/        # Static files (images, etc.)
β”œβ”€β”€ /styles/        # Tailwind CSS styles
β”œβ”€β”€ /contracts/     # Smart contracts
└── README.md       # Project documentation

Learn More

If you want to learn more about Ethpreneur, check out the following resources:


Contributors 🀝

We want to recognize all the fantastic people who have contributed to the project. You can view the full list of contributors here.

How to add yourself as a contributor:


License πŸ“

This project is licensed under the MIT License – see the LICENSE file for details.


Contact

If you have any questions or feedback, feel free to reach out:


Where to List Contributors

You can list contributors in a CONTRIBUTORS.md file inside the root directory of your project. The file should follow this format:

# Contributors

Thank you to everyone who has contributed to Ethpreneur! πŸŽ‰

## Contributors List
- **Your Name** – Core Developer  
- **Contributor Name** – Bug Fixes  
- **Another Contributor** – Feature Development  

Feel free to add your name to this file when you make your first contribution!