https://github.com/anct-cartographie-nationale/timetable-to-osm-opening-hours

📚 Bibliothèque pour la transformation d'une série de plages horaires représentant un format emploi du temps vers le standard OSM pour les horaires d'ouverture.
https://github.com/anct-cartographie-nationale/timetable-to-osm-opening-hours

anct betagouv bibliotheque emploi-du-temps gouvernement horaires horaires-d-ouverture openinghours openstreetmap osm timetable

Last synced: 3 months ago
JSON representation

📚 Bibliothèque pour la transformation d'une série de plages horaires représentant un format emploi du temps vers le standard OSM pour les horaires d'ouverture.

• Host: GitHub
• URL: https://github.com/anct-cartographie-nationale/timetable-to-osm-opening-hours
• Owner: anct-cartographie-nationale
• License: mit
• Created: 2022-10-02T10:04:42.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-22T13:32:21.000Z (5 months ago)
• Last Synced: 2024-09-29T04:07:14.489Z (3 months ago)
• Topics: anct, betagouv, bibliotheque, emploi-du-temps, gouvernement, horaires, horaires-d-ouverture, openinghours, openstreetmap, osm, timetable
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@gouvfr-anct/timetable-to-osm-opening-hours
• Size: 121 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Timetable to OSM opening hours

## À propos

Bibliothèque pour la transformation d'une série de plages horaires représentant un format emploi du temps vers le standard OSM pour les horaires d'ouverture.  

Voir [la spécification OpenStreetMap opening hours](https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification) pour en savoir plus au sujet de la syntaxe cible.

## Table of contents

- 🪧 [À propos](#à-propos)

- 🚀 [Installation](#installation)

- 🛠️ [Usage](#usage)

- 🤝 [Contribution](#contribution)

- 🏗️ [Built With](#built-with)

- 📝 [Licence](#licence)

## Installation

```bash

yarn add @gouvfr-anct/timetable-to-osm-opening-hours

```

## Usage

## Test usage

// Insert deploy with gitpod ?

####

## Contribution

To setup the project locally see the [contributing guide](CONTRIBUTING.md)

## Built With

### Langages & Frameworks

- [TypeScript](https://www.typescriptlang.org/) Strongly typed programming language that builds on JavaScript

### Tools

#### CLI

- [Jest](https://jestjs.io/) framework to run automated tests.

  - Configuration: [.tooling/.eslint/.eslintrc.cjs](.tooling/.eslint/.eslintrc.cjs)

- [Eslint](https://eslint.org/) Static code analyzer to find syntax problems.

  - Configuration: [.tooling/.eslint/.eslintrc.cjs](.tooling/.eslint/.eslintrc.cjs)

  - Local Documentation: [.tooling/.eslint/.eslintrc.cjs](.tooling/.eslint/.eslintrc.cjs)

- [Prettier](https://prettier.io/) Opinionated code formatter.

  - Configuration: [.tooling/.prettier/.prettierrc.cjs](.tooling/.prettier/.prettierrc.cjs)

- [Husky](https://typicode.github.io/husky/#/) Modern native git hooks. Used for quality check on commit and push.

  - Configuration: [.husky](.husky)

- [Commitlint](https://github.com/conventional-changelog/commitlint) checks if your commit messages meet the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/).

  - Configuration: [.tooling/.commitlint/commitlint.config.cjs](.tooling/.commitlint/commitlint.config.cjs)

- [Lint-staged](https://github.com/okonet/lint-staged) execute commands on staged files.

  - Configuration: [.tooling/.lint-staged/.lintstagedrc](.tooling/.lintstaged/.lintstagedrc)

#### CI/CD

- [Github Actions](https://docs.github.com/en/actions)

- [Semantic release](https://github.com/semantic-release/semantic-release) Automates the whole package release workflow.

  - Configuration: [.tooling/.semantic-release/.semantic-release.config.cjs](.tooling/.semantic-release/.semantic-release.config.cjs)

## License

See the [LICENSE.md](LICENSE.md) file.