From 38a7e49d035b5053df52f00a02047af914d2729b Mon Sep 17 00:00:00 2001 From: raykkk Date: Wed, 29 Oct 2025 12:10:18 +0800 Subject: [PATCH] add project template --- project_template/README.md | 64 +++++++++++++++++++++++++++++++ project_template/main.py | 14 +++++++ project_template/requirements.txt | 1 + 3 files changed, 79 insertions(+) create mode 100644 project_template/README.md create mode 100644 project_template/main.py create mode 100644 project_template/requirements.txt diff --git a/project_template/README.md b/project_template/README.md new file mode 100644 index 0000000..b9b1ca4 --- /dev/null +++ b/project_template/README.md @@ -0,0 +1,64 @@ +# [Your Project Name] + +[Brief description of what this project demonstrates] + +## 🌳 Project Structure + +### Python Only + +``` +. +β”œβ”€β”€ README.md # Documentation +β”œβ”€β”€ main.py # Entry point +β”œβ”€β”€ requirements.txt # Dependencies +└── ... # Any files if necessary +``` + +### Full‑stack + +``` +. +β”œβ”€β”€ README.md # Documentation +β”œβ”€β”€ backend/ # Backend source code +β”‚ β”œβ”€β”€ main.py # Backend entry point +β”‚ β”œβ”€β”€ requirements.text # Dependencies +β”‚ └── ... # Other files +β”‚ +β”œβ”€β”€ frontend/ # Frontend source code +β”‚ β”œβ”€β”€ package.json # Frontend dependencies +β”‚ β”œβ”€β”€ public/ # Static assets (HTML, favicon, etc.) +β”‚ └── src/ # Frontend source +β”‚ └── ... # Other files +└── README.md +``` + +## πŸ“– Overview + +[Detailed description of the project, what it demonstrates, and key features] + +## πŸš€ Getting Started + +### Prerequisites + +- Python 3.10 or higher +- [Add other prerequisites like API keys, Node.js, etc.] + +### Installation + +```bash +pip install -r requirements.txt +``` + +### Usage + +```bash +python main.py +``` + +[Add usage examples and expected output] + +## πŸ› οΈ Features + +- [Feature 1] +- [Feature 2] +- [Feature 3] diff --git a/project_template/main.py b/project_template/main.py new file mode 100644 index 0000000..70714bf --- /dev/null +++ b/project_template/main.py @@ -0,0 +1,14 @@ +""" +[Your Project Name] - Entry Point + +This example demonstrates [brief description]. +""" +import agentscope + +def main(): + """Main function to run the example.""" + print(agentscope.__version__) + + +if __name__ == "__main__": + main() diff --git a/project_template/requirements.txt b/project_template/requirements.txt new file mode 100644 index 0000000..4b402c4 --- /dev/null +++ b/project_template/requirements.txt @@ -0,0 +1 @@ +agentscope