Skip to content

Latest commit

 

History

History
81 lines (56 loc) · 2.05 KB

README.md

File metadata and controls

81 lines (56 loc) · 2.05 KB
Raw

Shareby

Write code, notes and share with others!

Codacy Badge license

Features

  • Awesome Reponsive UI

  • Vs Code like Editor

    • Dark Mode
    • Options to use custom editor configuration
    • Generate images of codes right from the editor
    • Markdown preview
    • Allow to export codes

  • Text editor

    • With WYSIWYG Editor options
    • Youtube, Codepen can be embeded
    • Export as HTML or Markdown

  • Generates a unique link to share code/text

  • Protect shares by adding password

  • Options to decide when to expire links

  • Recent shares by others

Technical aspects

  • Used cryptographically-secure PRGN(CSPRGN) to generate unique urls. benchmark tests

    3 * 10^5 URIs per second with avg collision rate of ~ 0.0001%

  • Used in memory caching at application level for different HTTP requests

  • Introduced HTTP caching for static resources and shared codes

  • Used Puppeteer API to generate images using carbon [ref: carbon.now.sh]

You can find a helper repository for generating code images over here

Technologies used

  • Node.js
  • Express.js
  • React.js
  • MongoDB
  • Ant Design
  • Styled Components
  • Puppeteer API

Quick Start

git clone [email protected]:rohitbakoliya/shareby.git
cd shareby
yarn install
cd client & yarn install
yarn dev

NOTE: Dont' forget to create .env by copying the content of .env.example and updating with valid keys

Author

Rohit Bakoliya - rohitbakoliya