README.md


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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

![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, hang on the wall for guests at home or in the hotel, etc.

![wificard](https://user-images.githubusercontent.com/48166553/129261875-169841ab-e997-4596-af7f-ada0f68cd230.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. All pull requests must pass the automated lint checks before merging. Prettier format is run automatically as a pre-commit hook.

## Language Contribution Guide

We would love for you to contribute to different languages and help make it even better than it is today! As a language contributor, here are some steps we would like you to follow:

1. Add a translation to [`./src/translations.js`](./src/translations.js). Here's an example of the German translation:

   ```
   {
      id: 'de-DE',              // locale code
      name: 'German - Deutsch', // Display name in the format 'latinName - nativeName'
      rtl: false,               // Optional, true if this is a right-to-left language
      translation: {
         ...
      }
   }
   ```

2. Append an entry to the [Supported Languages](#supported-languages) table below.

## 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)       |
| Portuguese (Brazil) | [ismaelpereira](https://github.com/ismaelpereira) |
| Japanese            | [hatsu38](https://github.com/hatsu38)             |
| Russian             | [Teraskull](https://github.com/Teraskull)         |
| Ukrainian           | [Teraskull](https://github.com/Teraskull)         |
| Dutch               | [wouterbrink](https://github.com/wouterbrink)     |
| French              | [Divlo](https://github.com/Divlo)                 |
| Turkish             | [Riza Ergun](https://github.com/rizaergun)        |
| Hindi               | [Pushpender](https://github.com/PushpenderSaini0) |
| Catalan             | [aniol](https://github.com/aniol)                 |
| German              | [devofthings](https://github.com/devofthings)     |
| Indonesia           | [nyancodeid](https://github.com/nyancodeid)       |
| Polish              | [olekstomek](https://github.com/olekstomek)       |
| Arabic              | [Ahmed Tokyo](https://github.com/a-tokyo)         |
| Occitan             | [ensag-dev](https://github.com/ensag-dev)         |
| Italian             | [Domenico Pascucci](https://github.com/pasmimmo)  |
| Korean              | [Seungbin Oh](https://github.com/sboh1214)        |
| Norwegian           | [tplive](https://github.com/tplive)               |
| Hungarian           | [munkacsimark](https://github.com/munkacsimark)   |
| Serbian             | [demanderbag](https://github.com/demanderbag)     |
| Urdu                | [mHassan11](https://github.com/mHassan11)         |