neon-helper
v1.0.0
Published
CLI tool to integrate NeonDB with various frameworks
Downloads
5
Readme
neon-create
neon-create
is a CLI tool designed to simplify the integration of Postgres on Neon into various projects. It helps you quickly set up NeonDB and configure your project for seamless database integration.
Table of Contents
Installation
You can use neon-create
with npx
without needing to install it:
npx neon-create
If you prefer to install it globally, run:
npm install -g neon-create
Usage
To integrate Postgres on Neon into your project, execute:
The tool will guide you through the setup process, including configuration and optional schema initialization.
Contributing
We welcome contributions to neon-create
! To contribute:
- Fork the Repository: Create a fork of the repository on GitHub.
- Clone the Repository: Clone your fork to your local machine:
- Create a Branch: Create a new branch for your changes:
- Make Changes: Implement your changes or new features.
- Test Your Changes: Ensure that everything works as expected.
- Commit Your Changes: Commit your changes with a clear message:
- Push Your Changes: Push your branch to your forked repository:
- Create a Pull Request: Open a pull request on the original repository to merge your changes.
License
neon-create
is licensed under the MIT License. See the LICENSE
file for details.