GithubHelp home page GithubHelp logo

stickies's Introduction

Sticker Note App

A small web-app which allows users to arrange sticky notes on a canvas.

Dependencies

  • "firebase": "^9.2.0",
  • "konva": "^8.2.3",
  • "react": "^17.0.2",
  • "react-dom": "^17.0.2",
  • "react-konva": "^17.0.2-5",
  • "react-scripts": "4.0.3",
  • "web-vitals": "^1.0.1"

Get started

This project uses npm.

Clone this repository on your computer : git clone [email protected]:Alphasud/Stickies.git

Go to directory, then npm install

then, npm run start

It runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

In this app you can :

  • Add a sticky note anywhere on the screen.
  • Drag and drop a sticky note to a new location.
  • Delete a sticky note.
  • Set the text contained in a sticky note (either at creation or after).
  • Clear the canvas of all stickers and background.
  • Change the color of a sticky note.
  • Draw anywhere on the canvas, switch pen color (default is black), select eraser tool to erase, or erase all drawing at once (for now, drawing cannot be saved) (this feature uses the Konva library)
  • Paste an image link to set it as the canvas background.
  • Add/delete sticker image (initial image is random).
  • Change image on sticker image.
  • Save your canvas on a distant database (here I use Firestore from Firebase).
  • Share the URL with someone else.
  • Working together in realtime, even-thought technically possible, is not optimized since you would need to reload manually frequentely to see what your pair did.

Future features could include :

  • Authentication.
  • 'Private' dashboard with all your canvas and personal info.
  • Creating multiple canvas.
  • Sharing canvas with other user.
  • Saving the drawings.
  • Include type checking with prop types.
  • Use SCSS.
  • Better documentation.
  • Better UI, this one got a strong 2000's vibe^^

stickies's People

Contributors

alphasud avatar

Watchers

 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.