n8n-nodes-starter/README.md

42 lines
2.1 KiB
Markdown
Raw Normal View History

2022-08-11 10:18:01 +01:00
![Banner image](https://user-images.githubusercontent.com/10284570/173569848-c624317f-42b1-45a6-ab09-f0ea3c247648.png)
# n8n-nodes-suno-ai
2019-10-03 08:53:03 +02:00
This repository contains a custom n8n node for interacting with the Suno AI music generation service. This node is currently **under development**.
2022-06-13 16:50:13 +01:00
2022-08-11 10:18:01 +01:00
## Prerequisites
You need the following installed on your development machine:
* [git](https://git-scm.com/downloads)
2025-05-13 14:26:01 +01:00
* 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).
2022-08-11 10:18:01 +01:00
* Install n8n with:
```
2025-05-13 14:26:01 +01:00
npm install n8n -g
```
2022-08-11 10:18:01 +01:00
* 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)
2019-10-03 08:53:03 +02:00
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/).
2022-08-11 10:18:01 +01:00
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.
2022-06-13 16:46:20 +01:00
## 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.
2019-10-03 08:53:03 +02:00
## License
2022-06-17 13:54:14 -07:00
[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md)