Grapify

A lightweight npm package for generating graphs based on user inputs. Easily create visual representations like percentage-based charts, bar graphs, or pie (under construction) charts with customizable options. Ideal for data visualization in Node.js applications.

Features

• Generate percentage-based charts.
• Create bar graphs with customizable options.
• Support for pie charts (under development).
• Lightweight and easy to integrate into Node.js applications.

Installation

Install Grapify using npm:

npm install grapify 

Usage

This is for normal usage

const grapifyGraph = require("grapify");
const graph = grapifyGraph.Graph ;

const resultingGraph = graph({ColumsNames:"English,Math"},{Values:"100,100"});
console.log(resultingGraph);

Output

[
  { Column: 'Bangla', Value: 100 },
  { Column: 'English', Value: 100 }
]

If you want to create a graph for your school result than you can use this :- more advanced feature will be added in the near future InshaAllah

const grapifySchool = require("grapify");
const school = grapifySchool.School;

const resultingGraph = school(2,100,{ColumsNames:"English,Math"},{Values:"100,100"});
console.log(resultingGraph);

Grpah() takes 4 perams, 1st one is total number of columns, 2nd is maxValue , 3rd one ColumsName and 4th one takes Values

Output

[
  { Column: 'Bangla', valuePercentage: 100 },
  { Column: 'English', valuePercentage: 100 }
]

Roadmap

• [x] Percentage-based charts
• [x] Bar graphs
• [] Pie charts (in progress)

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

1. Fork the repository:
   • Click the "Fork" button on the top right of this repository.
2. Clone your forked repository:

   git clone https://github.com/AdnanDLuffy/Grapify.git

3. Create a new branch:

   git checkout -b feature-or-bugfix-name

4. Make your changes and commit them:

   git commit -m "Description of changes"

5. Push your changes to your fork:

   git push origin feature-or-bugfix-name

6. Submit a Pull Request:
   • Open a pull request from your branch to the main branch of this repository.
   • Provide a clear description of the changes and reference any relevant issues.

We appreciate your contributions and will review your pull request as soon as possible!

Issues

If you encounter any bugs, have feature requests, or need assistance, please open an issue in the Issues section of this repository. Be sure to include:

• A clear description of the issue or feature request.
• Steps to reproduce the issue (if applicable).
• Any relevant screenshots or error logs.

Your feedback helps us improve!

License

This project is licensed under the MIT License.

You are free to use, modify, and distribute this software under the terms of the MIT License. See the LICENSE file for more details.

-----Free Palestine ----