diff --git a/README.md b/README.md index 14baf5a6..c2ed3f23 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,7 @@ -# Doc2Pen +
+ -

- -Are you a student who is tired of having to write out assignments on paper, draw sketches by hand, scan each page, convert it all to a PDF, and finally submit? 😩 - -Does it seem too much of a hassle in this age of online education? 😫 - -If your answer is yes, then you've come to the right place! πŸ˜ƒ - -### Doc2Pen is the 1 stop shop for getting all your "handmade" assignments ready for submission digitally. πŸ₯³ - -- Use the highly customisable Editor page to type in text and get a handwritten document! πŸ“ -- Use the Sketch page to digitally draw in a handmade style! 🎨 -- And in the end, use the Media Manip page to convert your assignment into the appropriate format for submission! πŸ“š - -It really is that easy! 🎊 - -And the best part of all? **Doc2Pen is open source!** 🀩 +

Doc2Pen

![Issues](https://img.shields.io/github/issues/smaranjitghose/doc2pen) ![Pull Requests](https://img.shields.io/github/issues-pr/smaranjitghose/doc2pen) @@ -25,6 +10,15 @@ And the best part of all? **Doc2Pen is open source!** 🀩 [![License](https://img.shields.io/github/license/smaranjitghose/doc2pen)](https://github.com/smaranjitghose/doc2pen/blob/master/LICENSE) ![](https://img.shields.io/github/repo-size/smaranjitghose/doc2pen.svg?label=Repo%20size&style=flat-square)  +

+Are you a student who is tired of having to write out assignments on paper, draw sketches by hand, scan each page, convert it all to a PDF, and finally submit? 😩 + +Does it seem too much of a hassle in this age of online education? 😫 + +If your answer is yes, then you've come to the right place! πŸ˜ƒ +

+
+ ## DEMO ### Home Page @@ -43,7 +37,36 @@ And the best part of all? **Doc2Pen is open source!** 🀩 -## Features: + +## How it Works + +

Doc2Pen is the one stop-shop for getting all your "handmade" assignments ready for submission digitally. +

+ +- Use the highly customisable Editor page to type in text and get a handwritten document! πŸ“ +- Use the Sketch page to digitally draw in a handmade style! 🎨 +- And in the end, use the Media Manip page to convert your assignment into the appropriate format for submission! πŸ“š + +> It really is that easy! 🎊. And the best part of all? **Doc2Pen is open source!** 🀩 + +## Tech Stack πŸ’» + +React HTML5 React + +### Other Technologies + +- [React - Bootstrap](https://react-bootstrap.github.io/) +- [React - Helmet](https://www.npmjs.com/package/react-helmet): Document Head Management +- [React - Leaflet.js](https://react-leaflet.js.org/): Interactive Maps +- [React - Dropzone.js](https://react-dropzone.js.org/): Drag and drop file uploads +- [Rough.js](https://roughjs.com/): Make sketchy, hand drawn figures +- [Mousetrap](https://github.com/ccampbell/mousetrap): Handling Keyboard shortcuts +- [ReactJS - Snackbar](https://www.npmjs.com/package/react-js-snackbar): Making snackbars to provide brief messages +- [React Reveal](https://www.react-reveal.com/): Animations +- [JSPDF](https://www.npmjs.com/package/jspdf): Generate PDFs +- [React Scroll](https://www.npmjs.com/package/react-scroll): Smooth Scrolling between sections + +## Features - [ ] Type/Paste your assignments and get handwritten ones to download directly! Bye-Bye Pen&Paper - [ ] Make Sketches/Diagrams/Figures for your assignments/presentations @@ -60,89 +83,97 @@ And the best part of all? **Doc2Pen is open source!** 🀩 - [ ] JIFF to JPG - [ ] PNG(multiple) to PDF -## Basic structure of the project repository πŸ—ƒοΈπŸ“‚ - -```terminal -| -|- readme_assets # Contains all the images used for the README.MD -|- public # Contains the stylesheets, images and fonts. Any files within this directory will not be processed by Webpack but copied directly to the build folder. -|- src: # Contains all source code for the React application. - | - |- App.js - |- index.css - |- index.js - |-assets # Contains all the community brand assets - |-components # Contains all the components used within the app. - |-fonts # Contains all the fonts - |-pages # Contains all the sections of the page. - |- 404 - |- Home - |- Editor - |- Sketch - |-seo # Contains code for meta tags using react-helmet -``` +## Project Structure πŸ“‚ -### Tech Stack: πŸ’» -React HTML5 React +``` +root +β”œβ”€β”€ .github +β”œβ”€β”€ public +β”œβ”€β”€ readme_assets +β”œβ”€β”€ src +β”‚ β”œβ”€β”€ assets +β”‚ β”œβ”€β”€ components +β”‚ β”œβ”€β”€ fonts +β”‚ β”œβ”€β”€ Pages +β”‚ β”œβ”€β”€ scss +β”‚ β”œβ”€β”€ seo +β”‚ β”œβ”€β”€ App.js +β”‚ β”œβ”€β”€ App.test.js +β”‚ β”œβ”€β”€ index.js +β”‚ β”œβ”€β”€ index.scss +β”‚ β”œβ”€β”€ reportWebVitals.js +β”‚ └── setupTests.js +β”‚ +β”œβ”€β”€ .eslintrc.js +β”œβ”€β”€ .gitignore +β”œβ”€β”€ .prettierignore +β”œβ”€β”€ .prettierrc.js +β”œβ”€β”€ CODE_OF_CONDUCT.md +β”œβ”€β”€ CONTRIBUTING.md +β”œβ”€β”€ docker-compose.yml +β”œβ”€β”€ Dockerfile +β”œβ”€β”€ LINCENSE +β”œβ”€β”€ package-lock.json +β”œβ”€β”€ package.json +β”œβ”€β”€ WEB_OPTIMIZATION.md +└── yarn.lock +``` -## Under the hood: +- `readme_assets` - contains all the images used in the **README.MD** +- `public` - contains the stylesheets, images and fonts. Any files within this directory will not be processed by Webpack but copied directly to the build folder. +- `src` - contains all source code for the React application. +- `assets` - contains all the community brand assets + - `components` - contains all the components used within the app. + - `fonts` - contains all the fonts + - `pages` - contains all the sections of the page. + - `seo` - contains code for meta tags using react-helmet -- [React - Bootstrap](https://react-bootstrap.github.io/) -- [React - Helmet](https://www.npmjs.com/package/react-helmet): Document Head Management -- [React - Leaflet.js](https://react-leaflet.js.org/): Interactive Maps -- [React - Dropzone.js](https://react-dropzone.js.org/): Drag and drop file uploads -- [Rough.js](https://roughjs.com/): Make sketchy, hand drawn figures -- [Mousetrap](https://github.com/ccampbell/mousetrap): Handling Keyboard shortcuts -- [ReactJS - Snackbar](https://www.npmjs.com/package/react-js-snackbar): Making snackbars to provide brief messages -- [React Reveal](https://www.react-reveal.com/): Animations -- [JSPDF](https://www.npmjs.com/package/jspdf): Generate PDFs -- [React Scroll](https://www.npmjs.com/package/react-scroll): Smooth Scrolling between sections +## Code of Conduct -## Wish to fix a bug or add a new feature?[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dwyl/esta/issues)πŸ€πŸ½πŸ€: +Check out our [Code of Conduct](./CODE_OF_CONDUCT.md) before making contributions. -

+## Want to fix a bug or add a new feature? -Please check out our [contribution guidelines](./CONTRIBUTING.md) +Contributions of all kinds are welcomed. +Please check out our [Contribution Guidelines](./CONTRIBUTING.md). -## The geeksπŸ€“ behind this initiative: +## The geeksπŸ€“ behind this initiative **Our Project MaintainersπŸ‘¨β€πŸ«:** -

-    - -

- -
Smaranjit Ghose              -Anush Bhatia
+ + + + + + + + +

Smaranjit Ghose
Anush Bhatia
**Our valuable ContributorsπŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»** -## Open Source Programs we have been associated with: +## Open Source Programs we have been associated with

- - - + + + - - - - - + + + + +

-## Code of Conduct - -

- ## License -

+This work is licensed under Creative Commons Legal Code. ## Made with β™₯ for the students of the world!