naue-library-frontend v0.0.1-8
Naue-Frontend-Library
(replace or remove this)
Table of Contents
- About
- HDNET Standard Recommendations
- Software Requirements
- Setup
- Testing
- Workflows
- Architecture Decision Records
- Build Tools
- Linked Repositories
About
This repository contains ...
HDNET Standard Recommendations
This repository follows
Software Requirements
For the development environment to work node 16 and Yarn3 are required.
Setup
Technically linked Repositories
The following ... needs to be running on your local machine ...
| Linked Name/Repo | Required | Description |
|---|---|---|
| example-repository-name | yes | Provides a local proxy that makes all Docker containers available as virtual hosts via HTTPS (can be replaced with Traefik or Lando) |
Set Environment Variables
.env.local
| Variable Name | Required for First Setup | Value |
|---|---|---|
HTTPS_KEY_PATH | yes | path/to/projects/black-nginx-proxy/certs/dev.local.key |
HTTPS_CRT_PATH | yes | path/to/projects/black-nginx-proxy/certs/dev.local.crt |
Install Pre-commit Hooks
Finally, install the pre-commit hooks via
husky install && git config gitflow.path.hooks .husky
Build the Local Database and load Fixtures
example/script/command
Install Dependencies
Login to AWS to use dependency @viewport/library-next
This repository is using the viewport Library as a dependency. To use it, you need to be logged in to AWS. Please follow these instructions.
After logging in, you can install the dependencies via
yarn add @viewport/library-next
yarn install
Start the Dev Server
After all is set up you can start the dev server via
yarn run dev
Testing
yarn run test runs all tests.
Workflows
Branching Model
This repository uses the Gitflow Workflow.
Translations and Wording
The following workflows and rules are used for translations and wording ...
Architecture Decision Records
This repository uses Architecture Decision Records to document architectural decisions.
Build Tools
This repository uses the following build tools.
- Tool 1: example-tool-name
- Tool 2: example-tool-name
Linked Repositories
This repository is linked to the following repositories.
- Naue-frontend: naue-frontend
- Naue Assets: naue-assets
- viewport-frontend-library: viewport-frontend-library-next
- Naue-Ashtoo:
- Naue-Giroudhan: