Thank you for your interest in contributing to Postpipe 2.0! We welcome contributions from everyone.
- Node.js: v18 or higher
- npm: v9 or higher
- Databases: Local or cloud instances of the databases you wish to test (MongoDB, Postgres, etc.)
- Fork the repository on GitHub.
- Clone your fork locally:
git clone https://github.com/YOUR_USERNAME/PostPipe-2.0.git cd PostPipe-2.0 - Install dependencies:
npm install
- Set up Environment:
Copy
.env.exampleto.envand configure yourDATABASE_URI.
We have two main development zones:
- Backend Features: Work in
src/static-serverorsrc/connectors.- Run:
npm run test:static
- Run:
- Frontend/Components: Work in
src/dynamic-lab.- Run:
npm run dev:lab
- Run:
- Create a new branch for your feature or fix:
git checkout -b feature/my-new-feature
- Make your changes.
- Ensure your code follows our style guidelines (Prettier/ESLint).
- Push your branch to your fork.
- Open a Pull Request against the
mainbranch (or specific dev branch if instructed).
We use Prettier and ESLint to enforce code style. Please run the following before committing:
npx prettier --write .