traefik / faency Goto Github PK

Faency is the Traefik Labs React component library

Home Page: https://traefik.github.io/faency

License: Apache License 2.0

JavaScript 0.93% TypeScript 99.02% Shell 0.02% MDX 0.03%

faency's Introduction

Traefik (pronounced traffic) is a modern HTTP reverse proxy and load balancer that makes deploying microservices easy. Traefik integrates with your existing infrastructure components (Docker, Swarm mode, Kubernetes, Consul, Etcd, Rancher v2, Amazon ECS, ...) and configures itself automatically and dynamically. Pointing Traefik at your orchestrator should be the only configuration step you need.

. Overview . Features . Supported backends . Quickstart . Web UI . Documentation .

. Support . Release cycle . Contributing . Maintainers . Credits .

⚠️ Please be aware that the old configurations for Traefik v1.x are NOT compatible with the v2.x config as of now. If you're running v2, please ensure you are using a v2 configuration.

Overview

Imagine that you have deployed a bunch of microservices with the help of an orchestrator (like Swarm or Kubernetes) or a service registry (like etcd or consul). Now you want users to access these microservices, and you need a reverse proxy.

Traditional reverse-proxies require that you configure each route that will connect paths and subdomains to each microservice. In an environment where you add, remove, kill, upgrade, or scale your services many times a day, the task of keeping the routes up to date becomes tedious.

This is when Traefik can help you!

Traefik listens to your service registry/orchestrator API and instantly generates the routes so your microservices are connected to the outside world -- without further intervention from your part.

Run Traefik and let it do the work for you! (But if you'd rather configure some of your routes manually, Traefik supports that too!)

Features

Continuously updates its configuration (No restarts!)
Supports multiple load balancing algorithms
Provides HTTPS to your microservices by leveraging Let's Encrypt (wildcard certificates support)
Circuit breakers, retry
See the magic through its clean web UI
Websocket, HTTP/2, gRPC ready
Provides metrics (Rest, Prometheus, Datadog, Statsd, InfluxDB 2.X)
Keeps access logs (JSON, CLF)
Fast
Exposes a Rest API
Packaged as a single binary file (made with ❤️ with go) and available as an official docker image

Supported Backends

Quickstart

To get your hands on Traefik, you can use the 5-Minute Quickstart in our documentation (you will need Docker).

Web UI

You can access the simple HTML frontend of Traefik.

Documentation

You can find the complete documentation of Traefik v2 at https://doc.traefik.io/traefik/.

A collection of contributions around Traefik can be found at https://awesome.traefik.io.

Support

To get community support, you can:

join the Traefik community forum:

If you need commercial support, please contact Traefik.io by mail: mailto:[email protected].

Download

Grab the latest binary from the releases page and run it with the sample configuration file:

./traefik --configFile=traefik.toml

Or use the official tiny Docker image and run it with the sample configuration file:

docker run -d -p 8080:8080 -p 80:80 -v $PWD/traefik.toml:/etc/traefik/traefik.toml traefik

Or get the sources:

git clone https://github.com/traefik/traefik

Introductory Videos

You can find high level and deep dive videos on videos.traefik.io.

Maintainers

We are strongly promoting a philosophy of openness and sharing, and firmly standing against the elitist closed approach. Being part of the core team should be accessible to anyone who is motivated and want to be part of that journey! This document describes how to be part of the maintainers' team as well as various responsibilities and guidelines for Traefik maintainers. You can also find more information on our process to review pull requests and manage issues in this document.

Contributing

If you'd like to contribute to the project, refer to the contributing documentation.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Release Cycle

We usually release 3/4 new versions (e.g. 1.1.0, 1.2.0, 1.3.0) per year.
Release Candidates are available before the release (e.g. 1.1.0-rc1, 1.1.0-rc2, 1.1.0-rc3, 1.1.0-rc4, before 1.1.0).
Bug-fixes (e.g. 1.1.1, 1.1.2, 1.2.1, 1.2.3) are released as needed (no additional features are delivered in those versions, bug-fixes only).

Each version is supported until the next one is released (e.g. 1.1.x will be supported until 1.2.0 is out).

We use Semantic Versioning.

Mailing Lists

General announcements, new releases: mail at [email protected] or on the online viewer.
Security announcements: mail at [email protected] or on the online viewer.

Credits

Kudos to Peka for his awesome work on the gopher's logo!.

The gopher's logo of Traefik is licensed under the Creative Commons 3.0 Attributions license.

The gopher's logo of Traefik was inspired by the gopher stickers made by Takuya Ueda. The original Go gopher was designed by Renee French.

faency's People

Contributors

Stargazers

Watchers

Forkers

paulocfjunior matthieuh thedemodev devopstoday11 mmatur moutoum seedy gndz07 chrisdalley isabella232 crt-fork mdeliatf rungtruong mloiseleur

faency's Issues

[v0.9] Dark theme is not handling black color properly

This is causing inconsistencies in the documentation when using the dark theme.

The initial proposed solution by Mattieu is to use a design system config with static colors and have theme files consuming the design system config.

Additional information

Note: textColor="white"

SubNab background should be white instead of transparent

instead of

[Table] Update Table style

Dark theme

Light theme

Create a CardLink component

Extend the Card functionality to have an onClick handler or create another component that derives from Card and has an onClick handler prop.

react-eva-icons should be a faency devDependency

react-eva-icons should be a faency devDependency because this lib is only used in a .story file.

Css loaded after content on the doc website

[Tab] Add Tab component

Dark theme

Light theme

Add FormError component

Design #57.

Can't add icons inside components only as child nodes

When writing components, I faced the issue that it's not possible to use React Eva Icons inside of the components, by showing them based on Variants for example.

This issue is to find a way to do that or understand exactly why it's not possible.

Add Chip color red to display errors

[Button] Can't specify 'as' property directly on Button component

We should be able to specify an as property on a component in a way that it's rendered using a different Primitive that it usually should use. For some reason, it's not possible to do this in some places.

NavItem have an incorrect type

active is no a correct value for the NavItem variant property:

 <NavItem variant="active">

Add Switch component

Dark Theme

Light Theme

Create a website

Add a website for the documentation

Update Input style

Secondary buttons should have a background on hover

instead of

Input background should be white instead of transparent

instead of

Create a DefaultProp component to use on Docs

Based on what was discussed on #91, we should have a component to render props values nicely, according to their type.

For now, we can have the support for the following types:

string
number
boolean
color

Research: Menu component is not rendered on Jest unit tests

I needed to comment a test that used the Menu component because it was not being rendered on the snapshot generated by Jest.
This is probably some limitation on Jest or some incomplete test configuration since the component is working on other places.