<commit_before><h1 align="center">
	<img width="400" src="media/logo.png" alt="Logo">
	<br>
	<br>
</h1>

<p align="center">
	<b>🚨 Scoreboard @ <a href="http://luaus.rijks.website">luaus.rijks.website</a> 🚨</b>
</p>

[![Build Status](https://semaphoreci.com/api/v1/rijkvanzanten/luaus/branches/master/shields_badge.svg)](https://semaphoreci.com/rijkvanzanten/luaus)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

<br>

**luau** |ˈlo͞oou|  
noun (plural same or luaus)  

a Hawaiian party or feast, especially one accompanied by entertainment.


## Usage

Clone the repo and install the dependencies with
`$ npm install`

To start the app run
`$ npm run start`

To start the server with nodemon run
`$ npm run dev-server`

To watch for client-side file changes run
`$ npn run dev-client`

Add your own .env file with the following contents:
```
TWITTER_CONSUMER_KEY=<consumer_key>
TWITTER_CONSUMER_SECRET=<consumer_secret>
TWITTER_ACCESS_TOKEN_KEY=<access_token_key>
TWITTER_ACCESS_TOKEN_SECRET=<access_token_secret>
```

## NodeMCU module used
[`cjson`](https://nodemcu.readthedocs.io/en/master/en/modules/cjson/) - The JSON support module. Allows encoding and decoding to/from JSON.  
[`file`](https://nodemcu.readthedocs.io/en/master/en/modules/file/) - The file module provides access to the file system and its individual files.  
[`gpio`](https://nodemcu.readthedocs.io/en/master/en/modules/gpio/) - This module provides access to the GPIO (General Purpose Input/Output) subsystem.  
[`http`](https://nodemcu.readthedocs.io/en/master/en/modules/http/) - Basic HTTP client module that provides an interface to do GET/POST/PUT/DELETE over HTTP(S), as well as customized requests.  
[`net`](https://nodemcu.readthedocs.io/en/master/en/modules/net/) - This module is used for different server and client actions, like creating and closing a server  
[`node`](https://nodemcu.readthedocs.io/en/master/en/modules/node/) - The node module provides access to system-level features such as sleep, restart and various info and IDs.  
[`tmr`](https://nodemcu.readthedocs.io/en/master/en/modules/tmr/) - The tmr module allows access to simple timers, the system counter and uptime.  
[`uart`](https://nodemcu.readthedocs.io/en/master/en/modules/uart/) - The UART (Universal asynchronous receiver/transmitter) module allows configuration of and communication over the UART serial port.  
[`websocket`](https://nodemcu.readthedocs.io/en/master/en/modules/websocket/) - A websocket client module that implements RFC6455 (version 13) and provides a simple interface to send and receive messages.  
[`wifi`](https://nodemcu.readthedocs.io/en/master/en/modules/wifi/) - This module provides overall wifi configuration  
[`ws2812`](https://nodemcu.readthedocs.io/en/master/en/modules/ws2812/) - ws2812 is a library to handle ws2812-like led strips. It works at least on WS2812, WS2812b, APA104, SK6812 (RGB or RGBW).<commit_msg>Add NodeMCU module description to README<commit_after><h1 align="center">
	<img width="400" src="media/logo.png" alt="Logo">
	<br>
	<br>
</h1>

<p align="center">
	<b>🚨 Scoreboard @ <a href="http://luaus.rijks.website">luaus.rijks.website</a> 🚨</b>
</p>

[![Build Status](https://semaphoreci.com/api/v1/rijkvanzanten/luaus/branches/master/shields_badge.svg)](https://semaphoreci.com/rijkvanzanten/luaus)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

<br>

# **luaus** |ˈlo͞oou|  
noun  
a Hawaiian party or feast, especially one accompanied by entertainment.

Luaus is an online scoreboard for all your favorite (board) games. Wanna play a match of fooßball? Keep track of your score with Luaus!


## Usage

Clone the repo and install the dependencies with
`$ npm install`

To start the app run
`$ npm run start`

To start the server with nodemon run
`$ npm run dev-server`

To watch for client-side file changes run
`$ npn run dev-client`

Add your own .env file with the following contents:
```
TWITTER_CONSUMER_KEY=<consumer_key>
TWITTER_CONSUMER_SECRET=<consumer_secret>
TWITTER_ACCESS_TOKEN_KEY=<access_token_key>
TWITTER_ACCESS_TOKEN_SECRET=<access_token_secret>
```

## NodeMCU module used
[`cjson`](https://nodemcu.readthedocs.io/en/master/en/modules/cjson/) - The JSON support module. Allows encoding and decoding to/from JSON.  
[`file`](https://nodemcu.readthedocs.io/en/master/en/modules/file/) - The file module provides access to the file system and its individual files.  
[`gpio`](https://nodemcu.readthedocs.io/en/master/en/modules/gpio/) - This module provides access to the GPIO (General Purpose Input/Output) subsystem.  
[`http`](https://nodemcu.readthedocs.io/en/master/en/modules/http/) - Basic HTTP client module that provides an interface to do GET/POST/PUT/DELETE over HTTP(S), as well as customized requests.  
[`net`](https://nodemcu.readthedocs.io/en/master/en/modules/net/) - This module is used for different server and client actions, like creating and closing a server  
[`node`](https://nodemcu.readthedocs.io/en/master/en/modules/node/) - The node module provides access to system-level features such as sleep, restart and various info and IDs.  
[`tmr`](https://nodemcu.readthedocs.io/en/master/en/modules/tmr/) - The tmr module allows access to simple timers, the system counter and uptime.  
[`uart`](https://nodemcu.readthedocs.io/en/master/en/modules/uart/) - The UART (Universal asynchronous receiver/transmitter) module allows configuration of and communication over the UART serial port.  
[`websocket`](https://nodemcu.readthedocs.io/en/master/en/modules/websocket/) - A websocket client module that implements RFC6455 (version 13) and provides a simple interface to send and receive messages.  
[`wifi`](https://nodemcu.readthedocs.io/en/master/en/modules/wifi/) - This module provides overall wifi configuration  
[`ws2812`](https://nodemcu.readthedocs.io/en/master/en/modules/ws2812/) - ws2812 is a library to handle ws2812-like led strips. It works at least on WS2812, WS2812b, APA104, SK6812 (RGB or RGBW).

## TODOs & Wishlist
-  [ ] Button feedback on press
-  [ ] Sound effects when updating score
-  [ ] Update cursor to a [more fun one](https://previews.123rf.com/images/marigranula/marigranula1203/marigranula120300280/12657766-hand-pointing-up-Stock-Photo-finger.jpg)
-  [ ] Allow user to add name to box
-  [ ] Responsive design woop
-  [ ] Add more colors to pick from
-  [ ] Ability to kick players from lobby
_Checkout the [projects page](https://github.com/rijkvanzanten/luaus/projects/1), or our [issues](https://github.com/rijkvanzanten/luaus/issues) for a more up-to-date overview_

## License
MIT License

Copyright &copy; 2017 <NAME> & <NAME>
{'fraction_non_alphanumeric': 0.1294603361840165, 'fraction_numerical': 0.017841344736066057, 'mean_word_length': 4.714406065711879, 'pattern_counts': {'":': 0, '<': 37, '<?xml version=': 0, '>': 37, 'https://': 33, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3558284', 'n_tokens_mistral': 2461, 'n_tokens_neox': 2291, 'n_words': 617}