Skip to main content

Core Installation

The core package is automatically included when you install projax. For development or direct usage, follow these steps.

Installation​

As Part of projax​

The core package is included in the global projax installation:

npm install -g projax

For Development​

Clone the repository and install dependencies:

git clone https://github.com/josetwentyfour/projax.git
cd projax
npm install

Build the core package:

cd packages/core
npm install
npm run build

Or build from the root:

npm run build:core

Usage in Your Project​

If you want to use the core package directly in your project:

npm install @projax/core

Then import:

import { getAllProjects, addProject } from '@projax/core';

TypeScript Support​

The package includes TypeScript definitions. No additional @types package needed.

Next Steps​