Zanix - Core

🧭 Table of Contents

• Description
• Features
• Installation
• Basic Usage
• Documentation
• Contributing
• Changelog
• License
• Resources

🧩 Description

Zanix Core is the foundational library of the Zanix ecosystem — a modular toolkit designed to power Zanix applications and provide the core configuration layer for all Zanix-based projects.

It serves as the entry point for initializing, configuring, and managing core application services within the Zanix framework.

⚙️ Features

• Core utilities to initialize and manage Zanix projects
• Built-in support for REST, GraphQL, and WebSocket servers
• Simple and scalable project bootstrapping

📦 Installation

Install Zanix Core in your project using Deno:

import core from 'jsr:@zanix/core@[version]'

Important Setup Notes:

1. Install Deno Ensure Deno is installed on your system. Follow the official guide: Deno Installation Guide

2. VSCode Extension (Recommended) For syntax highlighting, IntelliSense, and linting, install the Deno extension from the Visual Studio Code Marketplace.

3. Add Deno to PATH Make sure Deno is accessible from your system’s terminal:

   • macOS/Linux: Add to your shell configuration file (e.g., .bashrc, .zshrc):

     export PATH="$PATH:/path/to/deno"
     
     
     

   • Windows: Add the Deno folder to your PATH via Environment Variables.

🚀 Basic Usage

Example of how to bootstrap a Zanix project:

import Zanix from 'jsr:@zanix/core@[version]'

// Initialize your project
await Zanix.bootstrap({
  server: {
    rest: { onCreate, ...options },
    graphql: { onCreate, ...options },
    socket: { onCreate, ...options },
  },
})

For more advanced examples and configuration options, refer to the full documentation.

📚 Documentation

Find detailed documentation, guides, and examples at: 🔗 https://github.com/zanix-io

🤝 Contributing

Contributions are always welcome! To get started:

1. Open an issue for bug reports or feature requests.
2. Fork the repository and create a feature branch.
3. Implement your changes following the project’s guidelines.
4. Add or update tests as needed.
5. Submit a pull request with a clear and descriptive summary.

🕒 Changelog

Check the CHANGELOG for a complete version history and release notes.

⚖️ License

This project is licensed under the MIT License. See LICENSE for more information.

🔗 Resources

• Deno Documentation
• Zanix Framework

Developed with ❤️ by Ismael Calle | @iscam2216