https://github.com/dl0312/bonfire.io-client
🔥 Tell your story around the bonfire
https://github.com/dl0312/bonfire.io-client
react react-hooks socket-io-client typescript
Last synced: about 1 year ago
JSON representation
🔥 Tell your story around the bonfire
- Host: GitHub
- URL: https://github.com/dl0312/bonfire.io-client
- Owner: dl0312
- Created: 2019-02-26T08:00:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T14:24:37.000Z (over 3 years ago)
- Last Synced: 2025-03-31T04:26:17.059Z (about 1 year ago)
- Topics: react, react-hooks, socket-io-client, typescript
- Language: TypeScript
- Homepage: https://bonfire-io.netlify.com/
- Size: 4.77 MB
- Stars: 14
- Watchers: 0
- Forks: 3
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🔥 Bonfire.io-client 🔥
## Description
### 🙋♂️ Tell your story around 🔥 the bonfire
## Dev stack
- React and especially use React's new feature 🎣 Hooks
- socket.io-client
## Features
- [x] New User
- [x] Get User Number
- [x] Get New Message
- [x] User Connection
- [ ] User Disconnection
- [ ] User Reconnection
## Getting Started
### Prerequisites
| Require | Description |
| ------------------------------------ | ------------------------------------------------------------------------- |
| [Git](https://git-scm.com/) | We follow the [GitHub Flow](https://guides.github.com/introduction/flow/) |
| [Node.js](nodejs.org) | 10.10 LTS or above |
| [Yarn](https://yarnpkg.com/lang/en/) | Recommend [stable version](https://github.com/yarnpkg/yarn/releases) |
#### Install Node, Yarn
The project manages the version of node through `nvm`
```bash
$ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash
$ command -v nvm
$ nvm install
$ which node
$ npm install -g yarn
```
In the project root as follows are performed through the `.nvmrc`
```
$ nvm use
Found '/Users/user/Github/higherlowerkor/.nvmrc' with version <10.10.0>
```
### env
fill out `.env` for your socket.io-server
```
REACT_APP_SERVER_URL=${your socket.io server url}
```
### Yarn CLIs
#### Install project
```bash
$ nvm use
...
$ yarn
```
#### Build project
```bash
$ yarn build
```
#### Test project
```bash
$ yarn test
```
#### Start project
```bash
$ yarn start
```
## References
This project was inspired by this site
- https://stresscompany.net/
## License
MIT