Skip to content

Commit

Permalink
#3 update ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
bfoujols committed Aug 22, 2024
1 parent 5288b2e commit a51474f
Show file tree
Hide file tree
Showing 6 changed files with 189 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/_summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* [Veliko](index.md)
* [Changelog](changelog.md)
23 changes: 23 additions & 0 deletions docs/assets/veliko.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# CHANGELOG

**Présentation des versions du mock veliko**

## v2.2.0 - 22/08/2024

**new features**

- [#7](https://github.com/studoo-app/mock-veliko-api/issues/7) Création du route pour init structure des données @bfoujols
- [#6](https://github.com/studoo-app/mock-veliko-api/issues/6) Add les vélos dans la station @bfoujols
- [#6](https://github.com/studoo-app/mock-veliko-api/issues/6) Add la liste des vélos dans la parc Velib @bfoujols

**bug Fixes**

- Refactorisation du code sur la gestion des initialisations avec 2 routes init/schema et init/data @bfoujols
- Update de la documentation OpenAPI @bfoujols

<br>

## v2.1.0 - 21/08/2024

**new features**

- [#2](https://github.com/studoo-app/mock-veliko-api/issues/2) À partir du nom d'une route, reconstruire URL getNameToPath() @bfoujols
- [#3](https://github.com/studoo-app/mock-veliko-api/issues/3) Add OpenAPI avec Redocly @bfoujols
- [#5](https://github.com/studoo-app/mock-veliko-api/issues/5) Initialisation des données sur l'api officiel Velib @bfoujols
- [#3](https://github.com/studoo-app/mock-veliko-api/issues/3) Add docker image https://hub.docker.com/repository/docker/bfoujols/mock-veliko-api @bfoujols

<br>

## Starting alpha API - 03/08/2024

Début du projet mock veliko
11 changes: 11 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,13 @@
# Mock API Server pour le projet Veliko

<figure markdown="span">
![Logo Veliko](assets/veliko.svg){ width="500" }
</figure>

## Introduction

Ce projet est un serveur API REST qui simule le comportement de l'API Velib.
Il est utilisé pour faire des projets pédagogiques (applicatif) qui utilisent l'API Velib sans avoir besoin de se connecter à l'API officielle.

L'API Velib est une API REST qui permet de récupérer des informations sur les stations Velib de la ville de Paris.
Voici le lien de l'API officielle : [https://www.velib-metropole.fr/donnees-open-data-gbfs-du-service-velib-metropole](https://www.velib-metropole.fr/donnees-open-data-gbfs-du-service-velib-metropole)
8 changes: 8 additions & 0 deletions docs/stylesheets/extra.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

112 changes: 112 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,117 @@
site_name: Mock API Veliko
site_url: https://studoo-app.github.io/mock-api-veliko/
repo_url: https://github.com/studoo-app/mock-api-veliko
copyright: 'Copyright © 2022 - 2024 Collectif Studoo'
edit_uri: edit/main/docs/

theme:
name: material
logo: assets/veliko.svg
icon:
repo: fontawesome/brands/github
note: fontawesome/solid/note-sticky
abstract: fontawesome/solid/book
info: fontawesome/solid/circle-info
tip: fontawesome/solid/bullhorn
success: fontawesome/solid/check
question: fontawesome/solid/circle-question
warning: fontawesome/solid/triangle-exclamation
failure: fontawesome/solid/bomb
danger: fontawesome/solid/skull
bug: fontawesome/solid/robot
example: fontawesome/solid/flask
quote: fontawesome/solid/quote-left
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
scheme: default
primary: white
accent: amber
toggle:
icon: material/brightness-auto
name: Switch to light mode

# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
accent: amber
toggle:
icon: material/brightness-7
name: Switch to dark mode

# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: amber
toggle:
icon: material/brightness-4
name: Switch to system preference
features:
- content.action.edit
- content.code.copy
- navigation.footer
- navigation.instant
- navigation.instant.prefetch
- navigation.tabs
- navigation.top
- navigation.path
- search.highlight
- content.code.copy
- content.code.select
language: fr

extra:
version:
default: stable
social:
- icon: fontawesome/brands/github
link: https://github.com/studoo-app
- icon: fontawesome/brands/docker
link: https://www.docker.com
- icon: fontawesome/brands/php
link: https://php.net
generator: false

markdown_extensions:
- admonition
- tables
- toc:
permalink: true
- pymdownx.details
- pymdownx.superfences
- def_list
- pymdownx.tasklist:
clickable_checkbox: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- attr_list
- md_in_html

plugins:
- offline
- search
- literate-nav:
nav_file: _summary.md
- git-committers:
repository: studoo-app/mock-api-veliko
branch: main
- git-revision-date-localized:
enable_creation_date: true

extra_css:
- stylesheets/extra.css

0 comments on commit a51474f

Please sign in to comment.