Félix Malfait
30a2164980
Quick proof of concept for twenty-apps + twenty-cli, with local development / hot reload Let's discuss it! https://github.com/user-attachments/assets/c6789936-cd5f-4110-a265-863a6ac1af2d
176 lines
4.2 KiB
Markdown
176 lines
4.2 KiB
Markdown
# Your App Name
|
|
|
|
A brief description of what your application does and the problems it solves.
|
|
|
|
## 🚀 Features
|
|
|
|
- **Feature 1**: Description of what this feature does
|
|
- **Feature 2**: Description of what this feature does
|
|
- **Feature 3**: Description of what this feature does
|
|
|
|
## 📦 What Gets Installed
|
|
|
|
When you install this application, Twenty will automatically create:
|
|
|
|
### 🗂️ Objects
|
|
- **Example Object**: Description of what this object represents
|
|
|
|
### 👥 Roles
|
|
- **App Administrator**: Full access to all app features
|
|
- **App User**: Standard user access with limited permissions
|
|
|
|
### ⚡ Functions
|
|
- **Example Function**: Description of what this function does
|
|
|
|
### 🤖 AI Agents
|
|
- **App Assistant**: AI helper for app-related questions and tasks
|
|
|
|
### 📊 Views
|
|
- **All Example Objects**: Default view showing all example objects
|
|
|
|
## 🛠️ Installation
|
|
|
|
### Prerequisites
|
|
- Twenty CRM instance running
|
|
- Valid workspace ID
|
|
- Server built (`npx nx build twenty-server`)
|
|
|
|
### Install Command
|
|
```bash
|
|
npx nx app:install twenty-server \
|
|
--source "./packages/twenty-apps/your-app-name" \
|
|
--workspaceId "your-workspace-id" \
|
|
--sourceType "local" \
|
|
--verbose
|
|
```
|
|
|
|
### Development Mode
|
|
For active development with auto-sync:
|
|
|
|
```bash
|
|
npx nx app:dev twenty-server \
|
|
--appPath "./packages/twenty-apps/your-app-name" \
|
|
--workspaceId "your-workspace-id" \
|
|
--verbose
|
|
```
|
|
|
|
## 📖 Usage
|
|
|
|
### Getting Started
|
|
1. After installation, navigate to the new objects in your Twenty workspace
|
|
2. Assign users to the appropriate roles (App Administrator or App User)
|
|
3. Start creating records using the new objects
|
|
4. Use the AI assistant for help and guidance
|
|
|
|
### Common Workflows
|
|
|
|
#### Workflow 1: [Describe a common use case]
|
|
1. Step 1 description
|
|
2. Step 2 description
|
|
3. Step 3 description
|
|
|
|
#### Workflow 2: [Describe another use case]
|
|
1. Step 1 description
|
|
2. Step 2 description
|
|
3. Step 3 description
|
|
|
|
### Tips and Best Practices
|
|
- **Tip 1**: Helpful advice for users
|
|
- **Tip 2**: Another useful tip
|
|
- **Tip 3**: Best practice recommendation
|
|
|
|
## 🔧 Configuration
|
|
|
|
### Role Permissions
|
|
- **App Administrator**: Can read and update all records
|
|
- **App User**: Limited to their own records (customize as needed)
|
|
|
|
### Field Customization
|
|
You can customize the following fields after installation:
|
|
- Field 1: How to customize it
|
|
- Field 2: How to customize it
|
|
|
|
### Function Configuration
|
|
The serverless functions can be configured for:
|
|
- Setting 1: Description
|
|
- Setting 2: Description
|
|
|
|
## 🤝 Integration
|
|
|
|
### With Existing Objects
|
|
This app integrates with Twenty's core objects:
|
|
- **Companies**: How it relates to companies
|
|
- **People**: How it relates to people
|
|
- **Opportunities**: How it relates to opportunities
|
|
|
|
### API Usage
|
|
Access your app's data via Twenty's GraphQL API:
|
|
|
|
```graphql
|
|
query GetExampleObjects {
|
|
exampleObjects {
|
|
id
|
|
name
|
|
status
|
|
createdDate
|
|
}
|
|
}
|
|
```
|
|
|
|
### Webhooks
|
|
Set up webhooks to react to changes:
|
|
- When example objects are created
|
|
- When status changes
|
|
- When records are updated
|
|
|
|
## 🚨 Troubleshooting
|
|
|
|
### Common Issues
|
|
|
|
**Issue 1: [Common problem]**
|
|
- **Cause**: Why this happens
|
|
- **Solution**: How to fix it
|
|
|
|
**Issue 2: [Another problem]**
|
|
- **Cause**: Why this happens
|
|
- **Solution**: How to fix it
|
|
|
|
### Getting Help
|
|
1. Check the AI assistant for quick help
|
|
2. Review the Twenty documentation
|
|
3. Ask in the Twenty Discord community
|
|
4. Open an issue on GitHub
|
|
|
|
## 🔄 Updates
|
|
|
|
### Version History
|
|
- **v1.0.0**: Initial release with core features
|
|
|
|
### Updating
|
|
To update to a newer version:
|
|
```bash
|
|
npx nx app:install twenty-server \
|
|
--source "./packages/twenty-apps/your-app-name" \
|
|
--workspaceId "your-workspace-id" \
|
|
--sourceType "local"
|
|
```
|
|
|
|
## 📄 License
|
|
|
|
This application is licensed under [LICENSE] - see the LICENSE file for details.
|
|
|
|
## 🤝 Contributing
|
|
|
|
Contributions are welcome! Please read the [contributing guidelines](../CONTRIBUTING.md) before submitting changes.
|
|
|
|
### Development Setup
|
|
1. Fork the repository
|
|
2. Create a feature branch
|
|
3. Make your changes
|
|
4. Test thoroughly
|
|
5. Submit a pull request
|
|
|
|
---
|
|
|
|
**Need help?** The App Assistant AI agent is available in your Twenty workspace to help with questions and provide guidance on using this application effectively!
|