feat: start new project

esbuild.config.dev.js

@@ -11,8 +11,7 @@ export default {
     banner: {
       js: `const _importMetaUrl = new URL(import.meta.url).pathname;`,
     },
-    external: ["commander", "dockerode", "dotenv", "ethers", "inquirer", "update-check", "ssh2", "esbuild"]
-
+    external: ["commander", "dockerode", "dotenv", "ethers", "inquirer", "update-check", "ssh2", "fs-extra"]
   },
   watch: true,
 };

esbuild.config.prod.js

@@ -11,7 +11,7 @@ export default {
     banner: {
       js: `const _importMetaUrl = new URL(import.meta.url).pathname;`,
     },
-    external: ["commander", "dockerode", "dotenv", "ethers", "inquirer", "update-check", "ssh2", "esbuild"]
+    external: ["commander", "dockerode", "dotenv", "ethers", "inquirer", "update-check", "ssh2", "fs-extra"]
   },
   watch: false,
 };

eslint.config.js

@@ -24,7 +24,8 @@ export default [
       "eslint.config.js",
       "Config.js",
       "commitLint.config.ts",
-      "scripts/postinstall.js"
+      "scripts/postinstall.js",
+      "templates/**/*"
     ],
     plugins: {
       "@typescript-eslint": tseslint,

package.json

@@ -37,6 +37,7 @@
   "devDependencies": {
     "@release-it/conventional-changelog": "^10.0.0",
     "@types/dockerode": "^3.3.31",
+    "@types/fs-extra": "^11.0.4",
     "@types/inquirer": "^9.0.7",
     "@types/node": "^22.0.0",
     "@types/sinon": "^17.0.3",
@@ -62,6 +63,7 @@
     "dockerode": "^4.0.2",
     "dotenv": "^16.4.5",
     "ethers": "^6.13.4",
+    "fs-extra": "^11.3.0",
     "genlayer-js": "^0.6.0",
     "inquirer": "^12.0.0",
     "node-fetch": "^3.0.0",

src/commands/scaffold/index.ts

@@ -0,0 +1,16 @@
+import { Command } from "commander";
+import { NewAction } from "./new";
+
+export function initializeScaffoldCommands(program: Command) {
+  program
+    .command("new <projectName>")
+    .description("Create a new GenLayer project using the default template")
+    .option("--path <directory>", "Specify the directory for the new project", ".")
+    .option("--overwrite", "Overwrite existing directory if it exists", false)
+    .action(async (projectName, options) => {
+      const newProjectAction = new NewAction();
+      await newProjectAction.createProject(projectName, options);
+    });
+
+  return program;
+}

src/commands/scaffold/new.ts

@@ -0,0 +1,34 @@
+import fs from "fs-extra";
+import path from "path";
+import { fileURLToPath } from "url";
+import { BaseAction } from "../../lib/actions/BaseAction";
+
+export class NewAction extends BaseAction {
+  private templatePath: string;
+
+  constructor() {
+    super();
+    const __filename = fileURLToPath(import.meta.url);
+    const basePath = path.resolve(path.dirname(__filename), "..");
+    this.templatePath = path.join(basePath, "templates", "default");
+  }
+
+  async createProject(projectName: string, options: { path: string; overwrite: boolean }) {
+    const targetPath = path.resolve(options.path, projectName);
+
+    if (fs.existsSync(targetPath) && !options.overwrite) {
+      return this.failSpinner(
+        `Project directory "${targetPath}" already exists. Use --overwrite to replace it.`
+      );
+    }
+
+    this.startSpinner(`Creating new GenLayer project: ${projectName}`);
+
+    try {
+      fs.copySync(this.templatePath, targetPath);
+      this.succeedSpinner(`Project "${projectName}" created successfully at ${targetPath}`);
+    } catch (error) {
+      this.failSpinner(`Error creating project "${projectName}"`, error);
+    }
+  }
+}

src/index.ts

@@ -8,6 +8,7 @@ import { initializeContractsCommands } from "../src/commands/contracts";
 import { initializeConfigCommands } from "../src/commands/config";
 import {initializeValidatorCommands} from "../src/commands/validators";
 import { initializeUpdateCommands } from "../src/commands/update";
+import { initializeScaffoldCommands } from "../src/commands/scaffold";
 
 export function initializeCLI() {
   program.version(version).description(CLI_DESCRIPTION);
@@ -17,6 +18,7 @@ export function initializeCLI() {
   initializeConfigCommands(program);
   initializeUpdateCommands(program)
   initializeValidatorCommands(program);
+  initializeScaffoldCommands(program);
   program.parse(process.argv);
 }
 

templates/default/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 YeagerAI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

templates/default/README.md

@@ -0,0 +1,101 @@
+# Sample GenLayer project
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/license/mit/)
+[![Discord](https://dcbadge.vercel.app/api/server/8Jm4v89VAu?compact=true&style=flat)](https://discord.gg/8Jm4v89VAu)
+[![Telegram](https://img.shields.io/badge/Telegram--T.svg?style=social&logo=telegram)](https://t.me/genlayer)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/yeagerai.svg?style=social&label=Follow%20%40GenLayer)](https://x.com/GenLayer)
+[![GitHub star chart](https://img.shields.io/github/stars/yeagerai/genlayer-project-boilerplate?style=social)](https://star-history.com/#yeagerai/genlayer-js)
+
+## 👀 About
+This project includes the boilerplate code for a GenLayer use case implementation, specifically a football bets game.
+
+## 📦 What's included
+- Basic requirements to deploy and test your intelligent contracts locally
+- Configuration file template
+<!-- - Test functions to write complete end-to-end tests -->
+- An example of an intelligent contract (Football Bets)
+- Example end-to-end tests for the contract provided
+
+## 🛠️ Requirements
+- A running GenLayer Studio (Install from [Docs](https://docs.genlayer.com/developers/intelligent-contracts/tooling-setup#using-the-genlayer-studio) or work with the hosted version of [GenLayer Studio](https://studio.genlayer.com/)). If you are working locally, this repository code does not need to be located in the same directory as the Genlayer Studio.
+
+## 🚀 Steps to run this example
+
+### 1. Configure environment
+   Rename the `.env.example` file to `.env`, then fill in the values for your configuration. The provided values are the standard values for a tipical GenLayer Studio deployed locally.
+
+### 2. Deploy the contract
+   Deploy the contract from `/contracts/football_bets.py` using the Studio's UI:
+   1. Open the GenLayer Studio interface in your web browser (usually at http://localhost:8080).
+   2. Create a new file in the "Contracts" section and paste the content of `/contracts/football_bets.py` (the content is different than the existing contract from the examples).
+   3. Navigate to the "Run and Debug" section.
+   4. Follow the on-screen instructions to complete the deployment process.
+
+### 3. Setup the frontend environment
+  1. All the content of the dApp is located in the `/app` folder.
+  2. Rename the `.env.example` file in the `/app` folder to `.env`.
+  3. Add the deployed contract address to the `/app/.env` under the variable `VITE_CONTRACT_ADDRESS`
+
+### 4. Run the frontend Vue app
+   Ensure your GenLayer Studio is running, and execute the following commands in your terminal:
+   ```shell
+   cd app
+   npm install
+   npm run dev
+   ```
+   The terminal should display a link to access your frontend app (usually at http://localhost:5173/).
+   For more information on the code see [GenLayerJS](https://github.com/yeagerai/genlayer-js).
+
+<!-- ### 5. Test contracts
+1. Install the Python packages listed in the `requirements.txt` file in a virtual environment.
+2. Make sure your GenLayer Studio is running. Then execute the following command in your terminal:
+   ```shell
+   pytest test
+   ``` -->
+
+## ⚽ How the Football Bets Contract Works
+
+The Football Bets contract allows users to create bets for football matches, resolve those bets, and earn points for correct bets. Here's a breakdown of its main functionalities:
+
+1. Creating Bets:
+   - Users can create a bet for a specific football match by providing the game date, team names, and their predicted winner.
+   - The contract checks if the game has already finished and if the user has already made a bet for this match.
+
+2. Resolving Bets:
+   - After a match has concluded, users can resolve their bets.
+   - The contract fetches the actual match result from a specified URL.
+   - If the Bet was correct, the user earns a point.
+
+3. Querying Data:
+   - Users can retrieve all bets.
+   - The contract also allows querying of points, either for all players or for a specific player.
+
+4. Getting Points:
+   - Points are awarded for correct bets.
+   - Users can check their total points or the points of any player.
+
+<!-- ## 🧪 Tests
+
+This project includes integration tests that interact with the contract deployed in the Studio. These tests cover the main functionalities of the Football Bets contract:
+
+1. Creating a bet
+2. Resolving a bet
+3. Querying bets for a player
+4. Querying points for a player
+
+The tests simulate real-world interactions with the contract, ensuring that it behaves correctly under various scenarios. They use the GenLayer Studio to deploy and interact with the contract, providing a comprehensive check of the contract's functionality in a controlled environment.
+
+To run the tests, use the `pytest test` command as mentioned in the "Steps to run this example" section. -->
+
+
+## 💬 Community
+Connect with the GenLayer community to discuss, collaborate, and share insights:
+- **[Discord Channel](https://discord.gg/8Jm4v89VAu)**: Our primary hub for discussions, support, and announcements.
+- **[Telegram Group](https://t.me/genlayer)**: For more informal chats and quick updates.
+
+Your continuous feedback drives better product development. Please engage with us regularly to test, discuss, and improve GenLayer.
+
+## 📖 Documentation
+For detailed information on how to use GenLayerJS SDK, please refer to our [documentation](https://docs.genlayer.com/).
+
+## 📜 License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

templates/default/app/.env.example

@@ -0,0 +1,2 @@
+VITE_CONTRACT_ADDRESS=""
+VITE_STUDIO_URL="https://studio.genlayer.com/api"

templates/default/app/.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

templates/default/app/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["Vue.volar"]
+}

templates/default/app/README.md

@@ -0,0 +1,5 @@
+# Vue 3 + Vite
+
+This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+
+Learn more about IDE Support for Vue in the [Vue Docs Scaling up Guide](https://vuejs.org/guide/scaling-up/tooling.html#ide-support).