DEV Community: Makwasi

Creating NPM package with Typescript.

Makwasi — Tue, 27 Feb 2024 16:35:38 +0000

Title: Unveiling JsonZiip: A Journey into Creating an NPM Package

Introduction:
Ever wished for a hassle-free way to zip JSON data in your Node.js projects? That's the gap I sought to fill when I embarked on the journey of creating the JsonZiip npm package. In this article, I'll walk you through the steps I followed, complete with code snippets and commands, to bring this idea to fruition.

Prerequisites:
Before diving into the creation of an npm package like JsonZiip, you'll need a solid understanding of TypeScript, Node.js, npm, and basic knowledge of package.json and module.exports.

Step 1: Setting Up the Project:
To start, let's set up our project directory and initialize it with npm.

mkdir json-ziip
cd json-ziip
npm init -y

This creates a new directory named json-ziip and initializes a new npm project with default settings.

Step 2: Installing Dependencies:
Next, we'll install the dependencies needed for our package. In this case, we'll use adm-zip for zip file manipulation.

npm install adm-zip

Step 3: Writing TypeScript Code:
Now, let's write the TypeScript code for our JsonZiip package. Create a file named index.ts in the project root directory and add the following code:

import fs from 'fs';
import AdmZip from 'adm-zip';

export function createZipFile(jsonData: any, outputFileName: string): void {
    fs.writeFileSync('temp.json', JSON.stringify(jsonData));

    const zip = new AdmZip();
    zip.addLocalFile('temp.json');
    zip.writeZip(outputFileName);

    fs.unlinkSync('temp.json');
}

This code defines a function createZipFile that takes JSON data and an output file name, creates a temporary JSON file, zips it, and then deletes the temporary file.

Step 4: Compiling TypeScript to JavaScript:
Since npm packages are distributed as JavaScript files, we need to compile our TypeScript code to JavaScript. Add the following TypeScript configuration in a tsconfig.json file:

{
    "compilerOptions": {
        "target": "ESNext",
        "module": "CommonJS",
        "strict": true,
        "esModuleInterop": true
    }
}

Now, compile the TypeScript code using the tsc command:

tsc

This generates JavaScript files from our TypeScript code.

Step 5: Documentation and Publishing:
With the code ready, it's time to document our package and publish it to npm. Add appropriate documentation comments to your code and update the package.json file with the necessary information.

npm login  # Log in to your npm account
npm publish

And that's it! Your JsonZiip npm package is now available for the world to use.

Conclusion:
Creating JsonZiip was a rewarding journey, from ideation to publication. By following these steps and leveraging the power of TypeScript and npm, I was able to create a valuable tool for developers worldwide. I encourage you to explore JsonZiip, contribute to its development, and share your feedback. Together, let's continue to innovate and empower developers with powerful solutions. Happy coding!

Setting Up Camunda 7.19 spring boot Development Environment.

Makwasi — Fri, 29 Sep 2023 12:46:32 +0000

Title: Unleashing Workflow Potential: A Closer Look at Camunda-Spring Boot Integration

In my previous post, we kicked off a journey into the realm of business process management (BPM) by exploring the exciting fusion of Camunda 7 with Spring Boot. Today, let's delve deeper and uncover how this integration empowers organizations to streamline their business operations and achieve unparalleled workflow efficiency.

Some of the benefits you will get include:

1. Accelerated Development:
The amalgamation of Camunda BPM with Spring Boot enables rapid application development. By seamlessly integrating Camunda's process orchestration capabilities within a Spring Boot application, developers can significantly speed up the development lifecycle.

2. Enhanced Scalability:
Leveraging the lightweight nature of Spring Boot and the scalability of Camunda, this integration is perfectly suited for both small-scale applications and enterprise-grade solutions. Whether you're building a startup's core workflow or an intricate enterprise-wide BPM system, this combination scales effortlessly. Not forgetting easy integration with other third-party applications.

3. Real-time Monitoring and Optimization:
Camunda's monitoring tools, especially Cockpit, provide real-time insights into the workflow's performance, allowing organizations to optimize processes on the fly. Spring Boot's flexibility complements this by seamlessly integrating with monitoring and logging systems, providing a comprehensive view of system health and performance.

Steps to Implement Camunda-Spring Boot Integration

In case you wondering how to get started, here's a brief overview:

**Ensure you have Installed Java Development Kit (JDK) (8+).
Create a starter application: Create a Spring Boot project using Camunda spring initializer Spring Initializr. It comes pre-configured making it quick and easy to get started.
Customize Camunda Configuration: Create a configuration class to tailor Camunda engine settings as per your application requirements.
Install Camunda BPM Modeler: Download and install Camunda BPM Modeler for designing and modeling BPMN processes.
Start Camunda Engine: Install and set up the Camunda engine on your system.

Your Turn!

Now that we've set the stage, it's your turn to dive into the world of Camunda-Spring Boot integration. Explore, experiment, and elevate your business processes to new heights.

Stay tuned for more insights on this powerful integration. In the next post, we'll explore creating a simple BPMN process and demonstrate its execution within a Spring Boot application.

Keep innovating, keep optimizing!

Beginner Github

Makwasi — Tue, 17 Aug 2021 07:01:02 +0000

My Zuri internship article

The first post, Ever

My first article on dev.to
✨Magic ✨

Features

Everything i have learned so far and i have practised.

Tech

My Experience :

[AngularJS] - HTML enhanced for web apps!
[Ace Editor] - awesome web-based text editor
[markdown-it] - Markdown parser done right. Fast and easy to extend.
[Twitter Bootstrap] - great UI boilerplate for modern web apps
[node.js] - evented I/O for the backend
[Express] - fast node.js network app framework [@tjholowaychuk ]
[Gulp] - the streaming build system
Breakdance - HTML to Markdown converter
[jQuery] - duh

And of course Dillinger itself is open source with a [public repository][dill]
on GitHub

Installation

What is github?

Its’ a Version Control System (VCS) which helps developers to collaborate and work simultaneously while tracking and maintaining a complete history of the changes of their project files.
There are two types of version control systems namely;
Centralized Version Control System
Distributed/Decentralized Version Control System.
Git falls under the Distributed Version Control System.
Distributed Version Control System (DVCS)

This system enables clients to check out the latest changes in the remote repository for example on GitHub or bit-bucket and allow them to clone the remote repository into their local working environment. This is very useful especially in cases when the server that has the remote repository goes down. In such an instance, the local repository on a client’s computer can then be push back to the server to restore it. Git does not entirely rely on the central server and therefore this is why you can perform operations offline locally such as committing, creating branches, and viewing commit logs. You only require the network connection when you need to push changes to the server (GitHub) or to pull the latest changes from the remote repository.
In this blog post, I will strive to bring you up to speed with the terminologies associated with git, git commands and operations that you will encounter most commonly while working on your projects and collaborating with a team.

Prerequisites.

You must have installed git on your computer otherwise visit https://git-scm.com
You should have a GitHub account. To Create a GitHub Account and sign in visit .https://github.com/
You should have an IDE ( Code Editor ) preferably Visual Studio Code. https://code.visualstudio.com/
Note that we often use Git Bash in Windows to perform the git operations and the Terminal for Mac and Linux. You could also use the integrated terminal in Visual Studio Code.
Okay with that noted let’s get started………😜
Common git Concepts and Operations.
Cloning / Creating Repositories
Basic git workflow
Pulling latest changes in a remote repository
Creating and working with Branches.
Merging Branches.
Resolving Merge Conflicts
Re-basing Branches
Hosting on GitHub page

Follow for more here.. https://zuri.team or https://internship.zuri.team or https://training.zuri.team