Skip to content

A writing app with editing features, note taking, Berserk Mode writing, todos, timer, and testing your typing speed.

Notifications You must be signed in to change notification settings

rileygramlich/scribist

Repository files navigation

Scribist

A writing app with editing features, Berserk Mode writing, and testing your typing speed.


Click to use Scribist!

Description and Background Info:

This utility app is built with the intention of helping people write more, especially with Berserk mode which allows you to pressure yourself with a word target and a timer set to reach that target.

Create and Edit Docs:

Create new documents for writing stories, or essays, or anything. This doc editor autosaves your work every 2 seconds. Also, if you want to collaborate with a friend on the document, just shoot them the link and you can see each other's changes appear live.

gif of doc page gif of doc page

Berserk Mode:

The purpose of this feature is to encourage your to have a continuous flow of writing. Berserk mode allows you to set a word target and a timer for how long you have to write targeted amount of words. The cool thing about this mode is that if you stop typing, it will start erasing your words! The buffer time before it's starts erasing is set to 2 seconds. So go berserk and don't stop writing!

gif of berserk mode gif of berserk mode

Screenshots:

Of Authorization Page: Screenshots

Of All Docs Page: Screenshots

Technologies Used:

The MERN (MongoDB, Express, React.js Node.js) stack was used to develop this full-stack web application.

  • MongoDB: used to deploy a live cloud server to store data in a database. User model with mongoose referencing for the known and known words (many to many), and mongoose embedding for the posts (one to many).

  • Express: used for handling all of the back-end operations (routing, schema data manipulation, and so on).

  • React.js: UI JavaScript Library. [more here]

  • Node.js: used as the live server environment, to monitor server operations, and view the web-app in a browser when running nodemon.

  • Javascript: used constantly throughout the application to write functions and manipulate the data accordingly.

  • CSS (including bootstrap and materialize libraries): used to style the app and make it look clean and pretty.

  • Github: used for version control.

  • VSCode Editor: used to write and code and manage file locations.

  • Trello: was used for making a do list list and managing tasks to get done.

  • Lucid: used to create an initial ERD (environment relationship diagram.

  • Figma: used to create the original wireframe.

  • Markdown: used to create this README.md

  • Google Chrome and its developer tools was used to test the app during production.

Getting Started:

Demo:

Click to write your dream project now!

Planned future enhancements:

  1. Add edit sections feature whereby you can drag and move a given section and it will re-render it on the Quill editor
  2. Add more consequences in Berserk Mode, for example have the screen turn crazy colors, or have it blast sounds at you.
  3. Sign in with Google Oauth, Github, or Facebook.
  4. Add ability to convert the doc various formats such as PDF, markdown, or html.
  5. Implement more on the about page and add donation option using Stripe.
  6. Style more and add animations and use a library like framer to have seamless popup interactivity.
  7. Add Ability to see more data about docs (words typed, created date, last updated, etc).
  8. Add search option in navbar to find docs faster.
  9. Add note-taking feature that can do todos (without all the text editing).
  10. Integrate ChatGPT API to aid for writing prompts and generating outlines.

About

A writing app with editing features, note taking, Berserk Mode writing, todos, timer, and testing your typing speed.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published