add project template
This commit is contained in:
64
project_template/README.md
Normal file
64
project_template/README.md
Normal file
@@ -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]
|
||||||
14
project_template/main.py
Normal file
14
project_template/main.py
Normal file
@@ -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()
|
||||||
1
project_template/requirements.txt
Normal file
1
project_template/requirements.txt
Normal file
@@ -0,0 +1 @@
|
|||||||
|
agentscope
|
||||||
Reference in New Issue
Block a user