aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 69331045c54b78fd9d42497016a97d51acc42380 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
![ci](https://github.com/bndw/wifi-card/workflows/ci/badge.svg)

# <img width="32px" src="./public/images/wifi.png"> WiFi Card

https://wificard.io

Print a simple card with your WiFi login details. Tape it to the fridge, keep it in your wallet, etc.

![wificard](https://user-images.githubusercontent.com/48166553/125853182-49fd361d-5797-4989-afbf-e6a617945be2.gif)

## Running locally

Run the official Docker image on http://localhost:8080

```
make run
```

## Development

1. Make sure you have `yarn` installed
2. Run the live-reload server on http://localhost:3000
   ```
   make dev
   ```

This project uses [Prettier](https://prettier.io/) formatting and all pull requests must pass
the automated lint checks prior to merging.

Run the lint check with:

```
make fmt
```

Rewrite the files to resolve any style issues with:

```
make fmt.write
```

## Supported Languages

| Language   | Author Credit                                 |
| ---------- | --------------------------------------------- |
| English    | [bndw](https://github.com/bndw)               |
| Chinese    | [Baoyuantop](https://github.com/Baoyuantop)   |
| Spanish    | [oscfdezdz](https://github.com/oscfdezdz)     |
| Portuguese | [pedrorenan](https://github.com/pedrorenan)   |
| Japanese   | [hatsu38](https://github.com/hatsu38)         |
| Russian    | [Teraskull](https://github.com/Teraskull)     |
| Ukrainian  | [Teraskull](https://github.com/Teraskull)     |
| Dutch      | [wouterbrink](https://github.com/wouterbrink) |