- Description
- Features
- Installation
- Basic Usage
- Documentation
- Contributing
- Changelog
- License
- Resources
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.
- Comprehensive core utilities for initializing, configuring, and managing Zanix projects with ease.
- Built-in support for modern communication layers including REST, GraphQL, and WebSocket servers.
- Lightweight and scalable project bootstrapping, designed to grow seamlessly with your application.
- Powerful HTTP connectors, such as
GraphQLClientandRestClient, providing a unified interface for API communication.
Install Zanix Core in your project using Deno:
import core from 'jsr:@zanix/core@[version]'Important Setup Notes:
-
Install Deno Ensure Deno is installed on your system. Follow the official guide: Deno Installation Guide
-
VSCode Extension (Recommended) For syntax highlighting, IntelliSense, and linting, install the Deno extension from the Visual Studio Code Marketplace.
-
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
PATHvia Environment Variables.
-
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.
Find detailed documentation, guides, and examples at: 🔗 https://github.com/zanix-io
Contributions are always welcome! To get started:
- Open an issue for bug reports or feature requests.
- Fork the repository and create a feature branch.
- Implement your changes following the project’s guidelines.
- Add or update tests as needed.
- Submit a pull request with a clear and descriptive summary.
Check the CHANGELOG for a complete version history and release notes.
This project is licensed under the MIT License. See LICENSE for more
information.
Developed with ❤️ by Ismael Calle | @iscam2216