Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/daoodaba975/galsenify

πŸ’« Galsenify is a package NPM that allows you to easily manipulate data about Senegal, it offers a lot of information about country of Teranga.
https://github.com/daoodaba975/galsenify

data made-in-senegal npm-package

Last synced: 12 days ago
JSON representation

πŸ’« Galsenify is a package NPM that allows you to easily manipulate data about Senegal, it offers a lot of information about country of Teranga.

Awesome Lists containing this project

README

        

# Galsenify πŸ“¦πŸ’«

![COVER](assets/img/cover.png)

**_Lire en [Français](./assets/translate/FR.md)_**

**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`

```bash
npm i galsenify
```

`via YARN`

```bash
yarn add galsenify
```

`via PNPM`

```bash
pnpm i galsenify
```

## Usage πŸ’‘

```js
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 🧩

```js
// 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](https://github.com/daoodaba975/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](https://galsenify.vercel.app).

## Author 🌟

[![Daouda BA](https://avatars.githubusercontent.com/daoodaba975?s=64)](https://github.com/daoodaba975)
Created by **[Daouda BA](https://github.com/daoodaba975)**

You can buy me a coffee β˜• and help the project to grow up πŸ™ŒπŸΎ

Buy Me A Coffee

## Contributing 🌍

⚠️ If you want contribute on this project, please check firt the **[Contributing Guide](./assets/CONTRIBUTING.md)**.

If you find 🐞 or you have a πŸ’‘ about the evolution of this project, you can open an **[issue](https://github.com/daoodaba975/galsenify/issues/new)**.
I'm also available on **[Twitter](https://twitter.com/daoodaba975)**.

A special thanks to [Dame LEYE (Honorable Con)](https://github.com/honorableCon) for his contribution on this project.

[![Honorable Con](https://avatars.githubusercontent.com/honorableCon?s=64)](https://github.com/honorableCon)

Thanks to all contributors πŸ‘πŸ½



## Changelog πŸ”

You can also consult the **[Changelog](./assets/CHANGELOG.md)** to see the different changes and evolution between versions.

## Licence 🎫

This package is released under the **[MIT Licence](./assets/LICENCE.md)** βœ”

[![Made-In-Senegal](https://github.com/GalsenDev221/made.in.senegal/blob/master/assets/badge.svg)](https://github.com/GalsenDev221/made.in.senegal)