Skip to content

themeWork-llc/themework

Repository files navigation

ThemeWork: Work on your text documents - together!

React React Router NodeJS Socket.io Redis Webpack

Introducing ThemeWork, a real-time text collaboration platform designed to bring people together. Whether it's working on a business proposal, academic paper, or creative writing project, ThemeWork offers a seamless experience for multiple users to edit and contribute to a shared document simultaneously.

themeWork

themeWork2

Quick Start

In order to run this application, you'll first need to install Redis and create a database on MongoDB. Once you've set those up, you're good to go!

Directions:

From your command line:

  • run redis-server to start your Redis instance.

From your source-code editor:

  1. Create a .env file in your root directory.

  2. Inside your .env, add

    MONGO_URI=<your mongo link here>

  3. npm install dependencies.

  4. Run npm run dev and you're good to go!

Built With

  • React
  • Websockets
  • Socket.io
  • Redis
  • MongoDB
  • Jest

Contributors

  • Sun Jin Kim
  • Wayne Leung
  • Hank McGill
  • Patryk Ploszaj

License

MIT

About

A live-sharing text editor, powered by Websockets

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •