https://github.com/thasup/n8n-server
https://github.com/thasup/n8n-server
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thasup/n8n-server
- Owner: thasup
- License: mit
- Created: 2025-05-18T09:42:57.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-06-03T14:37:46.000Z (7 months ago)
- Last Synced: 2025-09-08T14:58:33.239Z (4 months ago)
- Language: JavaScript
- Size: 300 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# n8n-nodes-starter
This repo contains example nodes to help you get started building your own custom integrations for [n8n](https://n8n.io). It includes the node linter and other dependencies.
To make your custom node available to the community, you must create it as an npm package, and [submit it to the npm registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry).
## 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 starter
These are the basic steps for working with the starter. For detailed guidance on creating and publishing nodes, refer to the [documentation](https://docs.n8n.io/integrations/creating-nodes/).
1. [Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from this template repository.
2. Clone your new repo:
```
git clone https://github.com//.git
```
3. Run `npm i` to install dependencies.
4. Open the project in your editor.
5. Browse the examples in `/nodes` and `/credentials`. Modify the examples, or replace them with your own nodes.
6. Update the `package.json` to match your details.
7. Run `npm lint` to check for errors or `npm lintfix` to automatically fix errors when possible.
8. Test your node locally. Refer to [Run your node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance.
9. Replace this README with documentation for your node. Use the [README_TEMPLATE](README_TEMPLATE.md) to get started.
10. Update the LICENSE file to use your details.
11. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm.
## More information
Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes.
## Deployment on Render
### Prerequisites
- Ensure you have a Render account
- Node.js version 20.15 or higher
### Deployment Steps
1. Fork this repository
2. Create a new Web Service on Render
3. Connect your GitHub repository
4. Configure the following settings:
- **Build Command**: `npm install && npm run build`
- **Start Command**: `npm start`
- **Runtime**: Node
- **Node Version**: 20.15.0
### Build Process Details
The build command `npm run build` executes two key steps:
- `tsc`: Compiles TypeScript files to JavaScript
- `gulp build:icons`: Builds project icons
### Environment Variables
Set the following environment variables in your Render dashboard:
- `NODE_VERSION`: 20.15.0
- Add any additional credentials required by your n8n nodes
### Troubleshooting
- Ensure all dependencies are correctly listed in `package.json`
- Check that the build and start scripts are properly configured
- Verify that environment variables are correctly set