Skip to content

Latest commit

 

History

History
110 lines (82 loc) · 4.22 KB

README.md

File metadata and controls

110 lines (82 loc) · 4.22 KB

Scaler School of Technology - Smart Contracts Course

Welcome to the project repository for the Scaler School of Technology's Smart Contracts Course. This repository is designed as a template for your final project submission. Each group is expected to fork this repository, create a new branch, and make contributions to their fork before submitting their work via a pull request.

📖 Project Overview

This repository contains the final project submission for Group . The project is part of the Smart Contracts Course and is designed to apply the knowledge you have gained throughout the course.

Each group has the freedom to:

  • Choose any blockchain platform (e.g., Ethereum, Solana, Polygon, etc.).
  • Select any project topic that aligns with the principles of blockchain and smart contracts.

📋 Project Details

Note: Replace the placeholders below with your actual project details.

  • Project Name: Enter your project name here.
  • Blockchain Platform: Specify the blockchain platform you are using (e.g., Ethereum, Solana, Polygon, etc.).
  • Network: Specify the network you are deploying to (e.g., Mainnet, Goerli Testnet, etc.).
  • Deployed Smart Contract Address: Provide the address of your deployed smart contract.
  • Wallet Address: Provide the wallet address used for deploying the contract.
  • Frontend Repository/Code:
    • Provide the relative path to the frontend code directory in this repository.
    • If hosted externally, provide the link to the frontend repository.
  • Team Members:
    1. Name (GitHub ID): List each team member and their GitHub ID here.
    2. Name (GitHub ID): Add additional members if applicable.
    3. Name (GitHub ID): Optional third member.
  • Project Description:
    Provide a brief description of your project, its purpose, and the problem it aims to solve.

🛠️ Instructions

Follow these steps to complete and submit your project:

  1. Fork this Repository:

    • Click the "Fork" button at the top right of this page.

  2. Clone Your Fork:

    • Clone the repository to your local machine: 
      git clone https://github.com/<your-github-username>/<repo-name>.git
cd <repo-name>

  3. Create a New Branch:

    • Name the branch after your group: 
      git checkout -b group-<group-number>

  4. Fill in the Project Details:

    • Update the "Project Details" section of this README.md file with your project specifics.

  5. Add Your Files:

    • Place your smart contracts, scripts, documentation, and any other necessary files in the appropriate directories.
    • Work on your actual project!
    • Add your frontend code to the frontend/ directory.

  6. Commit and Push:

    • Stage and commit your changes: 
      git add .
git commit -m "Initial submission for Group <group-number>"
    • Push the branch to your fork: 
      git push origin group-<group-number>

  7. Submit a Pull Request (PR):

    • Open a pull request to the upstream repository with the same branch name (group-<group-number>).

  8. Update the Group Spreadsheet:

📂 Directory Structure

/
├── README.md               # This file
├── .gitignore              # Ignore unnecessary files
├── contracts/              # Place smart contracts here
├── tests/                  # Place test files here
├── migrations/             # Migration scripts (optional)
├── project/                # Placeholder for group project files
├── frontend/               # Place frontend code here
└── package.json            # Node.js-based dependencies (if applicable)

📝 Guidelines

  • Branch Naming: Use group-<group-number> as your branch name.
  • Documentation: Provide clear and concise documentation for your project.
  • Testing: Ensure your contracts are thoroughly tested before submission.
  • Innovation: Feel free to get creative and explore unique project ideas!

Good luck!