Wave Tech Shared Framework

A framework made by Wavers to reuse code in a smarter way. 😎
Get to know more about us »

Carrers · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Built With
3. Getting Started
4. Contributing

About The Project

Tired of rewriting the same code over and over again? We are too.

This is a framework made by us, Wavers and developers like you, to increase our productivity and code quality.

Built With

• TypeScript
• Node.js

Getting Started

This is a guide to help you get started with the Wave Tech Shared Framework.

Installation

Below are the steps you need to follow to install the framework.

1. Install the package with a package manager of your choice (npm, pnpm, yarn, etc.)

npm install @wave-telecom/framework

2. Import the resources you need

import { Logger } from '@wave-telecom/framework/core';

3. Use the package

Logger.initialize('my-app');
Logger.info('Hello, world!');

Contributing

We are passionate about open source projects and we are always looking for new ways to improve our framework. With that said, we are open to contributions and would love to have your help.

If you have any suggestions, ideas or feedback, please feel free to open an issue or to create a fork and send us a pull request.

Contributing Guidelines

1. Fork the repository
2. Create a new branch for your feature (git checkout -b feature/amazing-feature)
3. Test the library locally
   • Build the library with your changes (pnpm run build)
   • Copy the local path of the library directory (pwd)
   • Install the local library in the local consumer application (npm i </path/to/wave-tech/framework>)
   • Test the library in the consumer application.
4. Commit your changes (git commit -m 'Add amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a Pull Request.