Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

66 lines (48 loc) · 2.04 KB
Raw

Prerequisites

Installation

  • Run pnpm install in the repository's root directory to install everything you need for development.
  • Run pnpm build in the root directory to build the modules.

Development

DFlex contains multiple packages that shapes the final product. All Packages are decoupled and work separately. Each package has it own universe including test and playground or at lease this is the initial plan.

DFlex is written entirely in plain JavaScript/TypeScript and doesn't depend on any specific framework. However, it's using the React for playground, Cypress and Playwright for end to end testing. It's also using Jest for unit testing and PNPM to manage the packages.

Clone the repository

git clone https://github.com/dflex-js/dflex.git
cd dflex
pnpm install

To start development you can use the following command:

pnpm start

This will run the development playground for the DnD package. Open the browser http://localhost:3001 to see the playground. You can check the code in the packages/dnd/playgrounds to see the available components and implementation.

Submitting a PR

1- Fork DFlex then clone the repository.

2- Create a new branch: git checkout -b my-branch-name.

3- Make your change.

4- Push to your fork and submit a pull request when ready.

Before submitting PR

  1. Check types pnpm check-types
  2. Check unit test pnpm jest
  3. Check linter pnpm lint
  4. Run playground pnpm start then:
    a. Check smoke test pnpm playwright test
    b. Check essential mechanism pnpm cy:run:vertical:chrome
    c. Check migrating between containers pnpm cy:run:vertical:chrome