mirror of
https://github.com/n8n-io/n8n-nodes-starter.git
synced 2025-11-01 15:52:24 -05:00
6c69a287fe
I've set up the foundational boilerplate for the Suno AI integration. Key changes include: - Restructured directories for nodes, credentials, interfaces, utils, tests, and docs. - Renamed and updated example files to Suno-specific names and conventions (SunoApi.credentials.ts, Suno.node.ts). - Updated package.json and root README.md for the Suno AI node. - Created .env.example with placeholders for Suno environment variables. - Added a dev-log.md with initial notes on authentication research strategy. - Scaffolded utils/sunoApi.ts with placeholder API functions and JSDoc comments. - Scaffolded nodes/Suno/Suno.node.ts with operations, properties, execute routing, and a placeholder SVG icon. - Scaffolded nodes/Suno/SunoTrigger.node.ts with a basic trigger structure and properties. - Defined initial TypeScript types in interfaces/SunoTypes.ts for common data structures (SunoTrack, SunoJob, etc.). - Created placeholder README.md files in new subdirectories. This commit establishes the project structure and lays the groundwork for implementing Suno AI API interactions and node functionality.
41 lines
2.1 KiB
Markdown
41 lines
2.1 KiB
Markdown
|
|
|
|
# n8n-nodes-suno-ai
|
|
|
|
This repository contains a custom n8n node for interacting with the Suno AI music generation service. This node is currently **under development**.
|
|
|
|
## Prerequisites
|
|
|
|
You need the following installed on your development machine:
|
|
|
|
* [git](https://git-scm.com/downloads)
|
|
* Node.js and pnpm. Minimum version Node 20. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL [here](https://github.com/nvm-sh/nvm). For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows).
|
|
* Install n8n with:
|
|
```
|
|
npm install n8n -g
|
|
```
|
|
* Recommended: follow n8n's guide to [set up your development environment](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/).
|
|
|
|
## Using this node (Development)
|
|
|
|
These are the basic steps for working with this node. For detailed guidance on creating and publishing nodes, refer to the [documentation](https://docs.n8n.io/integrations/creating-nodes/).
|
|
|
|
1. Clone this repo:
|
|
```
|
|
git clone https://github.com/<your organization>/<your-repo-name>.git
|
|
```
|
|
2. Run `npm i` to install dependencies.
|
|
3. Open the project in your editor.
|
|
4. The Suno node is located in `/nodes/Suno` and its credentials in `/credentials`.
|
|
5. Update the `package.json` to match your details if necessary.
|
|
6. Run `npm lint` to check for errors or `npm lintfix` to automatically fix errors when possible.
|
|
7. Test your node locally. Refer to [Run your node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance.
|
|
8. Once development is complete, you can [publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm.
|
|
|
|
## More information
|
|
|
|
Refer to n8n's [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes.
|
|
|
|
## License
|
|
|
|
[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md)
|