Skip to content

Latest commit

 

History

History
176 lines (112 loc) · 6.26 KB

README.nl.md

File metadata and controls

176 lines (112 loc) · 6.26 KB
Raw

ms-team-tickertape

MS Teams-tickertape

Slaklijn

Samenvatting

Uw code op uw eigen systeem operationeel krijgen.

Opmerking: Zorg ervoor dat u voldoet aan devereisten.

  1. Installatieproces:

    $ cd ticker-tape
$ hatch --version # optional, will print the version of our package to the terminal without modifying the source directory (e.g. `0.0.1`).
# Without hatch: $ python src/ticker_tape/app.py
$ hatch env create # optional, if the default env already exists you will be told
$ hatch shell # spawn a shell within an environment
(ticker-tape) $ pip show ticker-tape # optional, shows the project details, here 'ticker-tape', from `pyproject.toml`
# Name: ticker-tape
# Version: 0.0.1 # it takes this from src/ticker_tape/__about__.py
# ...
(ticker-tape) $ python -c "import sys;print(sys.executable)" # optional, see where your environment's python is located
(ticker-tape) $ pip install --upgrade pip # optional, the `run` command allows you to execute commands in an environment as if you had already entered it.
(ticker-tape) $ pip install -r requirements.txt # pipx won't do this
(ticker-tape) $ python -m setuptools_scm # optional, display the version of our package and perform any side-effects like writing to a file. (here: `_version.py`)
(ticker-tape) $ exit # optional, type `exit` to leave the environment

    **Verpak uw site met webpack:**Zodra u een website heeft die goed genoeg is om te gebruiken, moet u de applicatie verpakken met webpack. Deze pakketmap wordt vermeld in.gitignoreom te voorkomen dat het aan git wordt vastgelegd.

    Alle instellingen zouden nu klaar moeten zijn, dus alles wat je hoeft te doen: 1)$ hatch shell2)(ticker-tape) $ cd src/ticker_tape3)(ticker-tape) $ npm install4)(ticker-tape) $ npm run build

    Hierdoor ontstaat deapp.jsbestand - dat alle componenten bevat - in/src/ticker_tape/static/js/.

    Ontwikkeling met webpack:Als u uw website nog aan het ontwikkelen bent, in aafzonderlijke terminalsessie, nadat u het bovenstaande installatieproces heeft gevolgd, doet u het volgende: 1)$ hatch shell2)(ticker-tape) $ cd src/ticker_tape3)(ticker-tape) $ npm install4)(ticker-tape) $ npm run watch

    Dit zal - in de afzonderlijke terminalsessie (d.w.z.background) - laad voortdurend de wijzigingen die u aanbrengt in de juiste bestanden, terwijl u door kunt gaan met het aanbrengen van die wijzigingen - in de initiële terminalsessie (d.w.z.foreground). Je hoeft dus niet na elke bewerking je bronnen opnieuw op te bouwen, dit gebeurt automatisch!

    Om de wijzigingen te zien, hoeft u alleen maar uw navigator op te slaan en opnieuw te laden (meestal met F5).

    Zorg ervoor dat u uw webpagina als volgt uitvoert tijdens het testen met backend-functies: 1)(ticker-tape) $ cd src/ticker_tape2)(ticker-tape) $ python app.py

    Test

    Test de applicatie (frontend) op deze manier:

    1)$ hatch shell2)(ticker-tape) $ cd src/ticker_tape3)(ticker-tape) $ npm install4)(ticker-tape) $ npm test5)(ticker-tape) $ npm test -- --coverage

    Loop:

    Als u niet aan het ontwikkelen bent, voert u de applicatie (backend en frontend tegelijkertijd) op deze manier uit:

    $ hatch run python src/ticker_tape/app.py # starts the app

  2. Software-afhankelijkheden

  3. Nieuwste releases

  4. API-referenties

  5. Bouwen en testen:

    Om uw code samen te stellen, gebruikt u:

    $ cd ticker-tape
$ hatch build

    Om AI te gebruiken voor beoordelingen van pull-aanvragen, gebruikt u:

    https://app.coderabbit.ai/dashboard

    Om de applicatie uit te voeren, gebruikt u:

    Linux:

    $ export SECRET_KEY="secret"

    Ramen:

    $ setx SECRET_KEY secret

    Dan:

    $ cd ticker-tape
# Without hatch: $ python src/ticker_tape/app.py
$ hatch run python src/ticker_tape/app.py

    Navigeer vervolgens naarhttp://127.0.0.1:5000/in uw webbrowser.

    Om tests uit te voeren, gebruikt u:

    $ cd ticker-tape
$ pip install pytest # optional
$ pytest tests/

API-documentatie

Navigeer naarhttp://127.0.0.1:5000/docsin uw webbrowser, of download de openapi.json vanhttp://127.0.0.1:5000/openapi.json.

Statistieken

Laat een stuk gereedschap als Prometheus schrapenhttp://127.0.0.1:9464/metrics.

NIEUW

Inhoudsopgave

Installatie

pip install ticker-tape

Versiebron

  • Dehatch-vcsversiebronplug-in bepaalt de projectversie met behulp van Git-tags

Omgevingen

  • Netjes gedefinieerd in een standalonehatch.toml
  • Detestmatrix maakt gebruik van deluikcontainersplug-in om elke omgeving binnen Docker-containers uit te voeren; gebruik is te zien in detestGitHub-workflow

Bouwen

  • Alle bouwdoelen gebruiken dehatch-vcsbouw een hook-plug-in om een_version.pybestand zodat de versie tijdens runtime kan worden gebruikt
  • Wielen gebruiken dehatch-mypycbouw hook-plug-in om eerst alle code mee te compilerenMijnpyc
  • DebouwenDe GitHub-workflow laat zien hoe u:
    • gebruikcibuildwielom binaire wielen voor elk platform te distribueren
    • gebruik deappbuild target om zelfstandige distributies voor elk platform te bouwen

Licentie

ticker-tapewordt verspreid onder de voorwaarden van deMETlicentie.

100 - Inleiding

ZienREADME.md

200 - Vereisten

ZienREADME.md

300 - Onze applicatie bouwen

ZienREADME.md

400 - Conclusie

ZienREADME.md