Developer Guide
Welcome to the NGXS community! We're excited to have you here. This guide will help you set up your local development environment and contribute effectively. 🚀
Prerequisites
Before you begin, ensure you have met the following requirements:
Installation
Follow these steps to set up your local environment:
Fork the repository if you haven't already. Learn how.
Clone the forked repository to your local machine using git.
Install project dependencies:
# Install root dependencies yarn install # Install dependencies for the "create-app" tutorial yarn --cwd tutorials/create-app
Build all packages:
yarn build:packages
Developing and Contributing
If you want to contribute to the project by fixing bugs, adding new features, or creating new packages, follow the steps below.
Modifying @ngxs/store
@ngxs/store
Run development mode:
yarn build:packages --package store --watch
Run serve integration examples:
yarn start
Make your changes...
Run tests to ensure everything works correctly:
yarn test
Commit changes following the Conventional Commits format.
Create a pull request with a detailed description of the changes.
Adding a New Package: @ngxs/<my-super-plugin>
@ngxs/<my-super-plugin>
Create a new package directory
packages/<my-super-plugin>
.Create a template library with
ngPackagr
.Add the package to
package.json
at the root level.Run development mode:
yarn build:packages --package <my-super-plugin> --watch
Develop your plugin...
Build the package:
yarn build:packages --package <my-super-plugin>
Run tests to ensure everything works correctly:
yarn test
Commit changes following the Conventional Commits format.
Create a pull request with a detailed description of the changes.
Last updated