README.md

Galsenify 📦💫

Lire en Français

Galsenify is a package that allows you to easily manipulate data about Senegal.
It offers a lot of information about Senegal.

• Current version ➡️ 1.0.0

Install 📥

via NPM

npm i galsenify

via YARN

yarn add galsenify

via PNPM

pnpm i galsenify

Usage 💡

import galsenify from "galsenify";
// or
const galsenify = require("galsenify");

// get all Senegal's regions
console.log(galsenify.regions());

// results
[
  "Dakar",
  "Diourbel",
  "Fatick",
  "Kaffrine",
  "Kaolack",
  "Kédougou",
  "Kolda",
  "Louga",
  "Matam",
  "Saint-Louis",
  "Sédhiou",
  "Tambacounda",
  "Thies",
  "Ziguinchor",
];

List of available commands 🧩

// Get all data about Senegal.
console.log(galsenify.sn());

// Get all national language.
console.log(galsenify.languesNationales());

// Get all data about region.
console.log(galsenify.rg());

// Get all regions.
console.log(galsenify.regions());

// Get departments by region.
// replace "region" by an existing region (example : Dakar)
console.log(galsenify.departments("region"));

// Get populations by region.
// replace "region" by an existing region (example : thies)
console.log(galsenify.population("region"));

// Get area by region.
// replace "region" by an existing region (example : KAOLACK)
console.log(galsenify.superficie("region"));

// Get all regions code.
console.log(galsenify.codes());

Example ✅

Galsenify Demo is a demo project to show you how to use the Galsenify package in Next.js project presented at #LiveKoorGalsenDEV event, you can see live here.

Author 🌟

Created by Daouda BA

You can buy me a coffee ☕ and help the project to grow up 🙌🏾

Contributing 🌍

⚠️ If you want contribute on this project, please check firt the Contributing Guide.

If you find 🐞 or you have a 💡 about the evolution of this project, you can open an issue.
I'm also available on Twitter.

A special thanks to Dame LEYE (Honorable Con) for his contribution on this project.

Thanks to all contributors 👏🏽

Changelog 🔁

You can also consult the Changelog to see the different changes and evolution between versions.

Licence 🎫

This package is released under the MIT Licence ✔