Git Product home page Git Product logo

slatesyncedit's Introduction

Websocket Editor

Websocket editor is website that allows teams to edit the same rich text editor simultaneously.

This project was bootstrapped with websocket-editor. Original code is working with slate v0.47. Here is an updated version which works with recent codebase, has support for images drag/drop & copy/paste.

Local development

To run app locally first start server and then open client React app(s).

Server-side (express + socket.io)

To start server:

  1. navigate to server folder
  2. run npm i to install dependencies
  3. Start server by running npm start or node server.js

Client-side (React + Slate)

In the project root directory run npm i to install client dependencies.

Then you can run:

  • npm start Runs the app in the development mode.
    Open http://localhost:3000 to view it in your browser. The page will reload when you make changes.
    You may also see any lint errors in the console.
  • npm run build Builds the app for production to the build folder.
    It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.
    Your app is ready to be deployed! See the section about deployment for more information.

Development with docker

Brefore you begin, ensure you have met the following requirements:

To run the development app, do the following:

  1. navigate to the projects root directory
  2. setup and run containers docker-compose up
  3. go to localhost:3000 in your browser

To run the production app, do the following:

  1. navigate to the projects root directory
  2. build app docker image docker build -t editorprodimg .
  3. create docker container and start the container
  docker run --name prodEditor -e NODE_ENV=production -p 4000:4000 editorprodimg

or in daemon mode:

  docker run --name prodEditor -e NODE_ENV=production -p 4000:4000 editorprodimg -d
  1. go to localhost:4000 in your browser

Teardown of Websocket Editor

To teardown the development app, do the following:

  1. navigate to the projects root directory
  2. stop and remove containers
  docker-compose down

To teardown the production app do the following:

  1. navigate to the projects root directory
  2. stop and remove containers
  docker rm -f prodApp

slatesyncedit's People

Contributors

regloom avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.