https://github.com/wisehackermonkey/remash
The idea for this project is to let reddit collaboratively write a book in a 24 hours.
https://github.com/wisehackermonkey/remash
Last synced: 3 months ago
JSON representation
The idea for this project is to let reddit collaboratively write a book in a 24 hours.
- Host: GitHub
- URL: https://github.com/wisehackermonkey/remash
- Owner: wisehackermonkey
- Created: 2020-06-14T04:48:54.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-19T17:16:09.000Z (over 3 years ago)
- Last Synced: 2025-01-07T15:44:06.532Z (4 months ago)
- Language: HTML
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Remash
### live book editor
```
by oran collins
github.com/wisehackermonkey
[email protected]
20190106 updated 20200613
```
# Project:
```
The idea for this project is to let reddit collaboratively write a book in a 24 hours.
It works similar to collaborative editing on google docs.
This project uses docker to host the web server, that I manage maintain,
To test it out open two tabs and type something, and see it replicate over to the other tab.
```
# (Easiest) Run using docker
# If you just want to try it out id recommend using play-with-docker.com
### [play-with-docker.com](https://labs.play-with-docker.com/)
# Run using docker for everyone else
```bash
docker login
>docker run -it --rm -p 80:8080 wisehackermonkey/remash
```
# Docker Run/Install
```bash
docker run -it --rm -p 80:8080 --name remash wisehackermonkey/remash
```
# Deploy
```bash
docker run -d --restart=always --name remash -p 8080:2000 wisehackermonkey/remash
```
# Deploy ARM (CURRENTLY NOT WORKING 20200929)
```bash
git clone https://github.com/wisehackermonkey/remash.git
cd remash
docker build . -t wisehackermonkey/remash:arm
docker login
docker push wisehackermonkey/remash:arm
docker run -d --restart=always --name remash -p 2000:8080 wisehackermonkey/remash
```
# The (hardway)
#### Install
```
pip install -r requirements.txt
```
##### run app in windows (CMD)
```bash
set FLASK_APP=main.py
set FLASK_ENV=development
flask run
```
##### run app in windows (POWERSHELL)
```bash
$env:FLASK_APP="main.py"
$env:FLASK_ENV="development"
flask run
```
#### Run app
```bash
>python main.py
```
### in browser go to
```
in browser go to
http://localhost:80
Type something into the text box
open another browser tab to
http://localhost:80
and type something else you will see the stuff replicated across the browser tabs!
```
## Bugs due to flask_socketio bug
#### bug is descripbed here
[stackoverflow.com](https://stackoverflow.com/questions/53522052/flask-app-valueerror-signal-only-works-in-main-thread)
# TODO
- capcha per character
- improve character syncing useing the same algorithm that google docs uses that was created by microsoft
# Links:
- [docs for flask-socketio](https://flask-socketio.readthedocs.io/en/latest/)
- [tutorial for use of flask and socket.io together](https://codeburst.io/building-your-first-chat-application-using-flask-in-7-minutes-f98de4adfa5d)