Code Monkey home page Code Monkey logo

doc2pen's Introduction

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! 🀩

Issues Pull Requests Forks Stars License Β 

DEMO

Home Page

Editor Page

Sketch Page

Media Manip Page

Features:

  • Type/Paste your assignments and get handwritten ones to download directly! Bye-Bye Pen&Paper
  • Make Sketches/Diagrams/Figures for your assignments/presentations
  • Media Manager
    • PDF Spliter
    • PDF Merger
    • PNG to JPG
    • JPG to PNG
    • PNG to WEBP
    • WEBP to PNG
    • JPG to WEBP
    • WEBP to PNG
    • JIFF to PNG
    • JIFF to JPG
    • PNG(multiple) to PDF

Basic structure of the project repository πŸ—ƒοΈπŸ“‚

|
|- 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

Tech Stack: πŸ’»

React HTML5 React

Under the hood:

Wish to fix a bug or add a new feature?contributions welcomeπŸ€πŸ½πŸ€:

Please check out our contribution guidelines

The geeksπŸ€“ behind this initiative:

Our Project MaintainersπŸ‘¨β€πŸ«:

   

Smaranjit Ghose              Anush Bhatia

Our valuable ContributorsπŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

Open Source Programs we have been associated with:

Code of Conduct

License

Made with β™₯ for the students of the world!

doc2pen's People

Contributors

abhipsaguru1012 avatar adyasha8105 avatar aniruddhmuley2001 avatar anushbhatia avatar ashuvssut avatar avishake007 avatar bhoomika07 avatar debanshu08 avatar dependabot[bot] avatar devmadhavvv avatar dipanshparmar avatar ekjotkaur avatar himanshujaidka avatar imgbotapp avatar mharshita avatar n-shar-ma avatar neeagwl avatar nijin26 avatar nishant23122000 avatar priyanshu-u avatar rishab-j avatar rohit-parameswaran avatar salmafarghaly avatar sameersrivastava13 avatar sanjay270899 avatar shilpe26 avatar smaranjitghose avatar smriti1313 avatar varun-28 avatar vedikaag99 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

doc2pen's Issues

Adding a .gitignore File

Description the change

To add a git ignore file to ensure that certain files are not tracked by git.

Error Handling

  • The input text or the page should have some limit to be accepted beyond which a warning message should be prompted

Adding a 404 Page.

Description the change

To add a 404 error page to keep a visitor on your site even if he/she hits a page that doesn't exist. Also to change the bad User experience to a positive one by adding some links to that 404 page so that the visitor can navigate to some other page.

Screenshots

Screenshot (39)

Adding a Footer

Description:

Currently there is no Footer at the bottom of the page. Therefore i would like to add a footer using materializecss

Screenshots:

Screenshot (73)

Contact

Suggested Sections

  • Topmost illustration
  • Project Maintainers: Name,Picture,LinkedIn,GitHub
  • Project Contributors: Name,Picture, LinkedIn
  • Info about open source, code of conduct, checkout and star on GitHub
  • Support Us Section [ Patreon + Buy Me a coffee]...Remove the floating icon

Variation in pen's tip

Description:

if we have feature of selecting tip size like 0.5mm and so on then it will give more realistic feel

Screenshots:

Editor

  • Side by Side Windows for screen you write and the output for example
  • Drop Down Menu for different fonts
  • Menu Bars kind of structure on top.
  • Better Buttons so that it looks more intriguing. refer this using this

PR template needed

Description:

  • There is no PR template right now.
  • I want to create a custom PR template so that Any new Contributor must be able to specify if he has met all the requirements like Clean Code, proper README and Documentation, Screenshots (If any) attached and more.

Please assign this to me as a part of CH20

Page Speed

Description:

The page speed of the website is good, but has a pretty good chance of improvement. General points on this are the format of the introductory video and general code practices. The detailed report is given below, with individual analysis for mobile and desktop.

Desktop:
https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fdoc2pen.smaranjitghose.codes%2F&tab=desktop

Mobile:
https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fdoc2pen.smaranjitghose.codes%2F&tab=mobile

Footer

A proper footer should be made for the website to look good

Home Page

  • A video of the Doc2Pen in optimized format (For any Problems just feel free to contact me)
  • Add a button to "Check out Editor"
  • Adding Features in a better format with illustrations
  • Experiment with Replacing video with a zoomed gif effect (Example given below)
  • Improve the content on the page
  • Work on the dark mode

Adding a Splash Screen

Description of the Feature

To give an end user immediate feedback that an application is starting and loading in the background.

Features

  • Export Options: jpg, png,pdf,docx
  • Adding Custom Fonts
  • Various Page Options like lined blank etc.
  • Different Pen Color
  • Text Size variation while writing
  • Custom Alignments so that i can place my text anywhere
  • Excalidraw Integration
  • Google Drive Integration
  • Chat Option using socket.io
  • Input Text Limit(no. of words that can be given as input)
  • Translator [Beta]

Bugs

  • Responsiveness
  • Card Structure

Landing Page

This is the first page that opens when a user visits the website. [ the index.html]

SEO

Add various meta tage required for it boost up the rating using lighthouse,pageinsights and gt metrix

Contact Page

  • A form
  • Link to the Project on GitHub
  • A section on code of conduct and LICENSE
  • Crafted by section:
    @smaranjitghose (Mine)
    @anushbhatia
    ^^ A card about us
  • Molded by section:
    All of your profiles

Better Font Collection

Description

The website can certainly use a better font collection to amp up the UI!
Add the necessary labels too.

Nav Bar

Minimal and Simple Nav Bar with white and dark mode toggle button present as well as
home
editor
contact
For inspiration refer this

UI changes

  • Input window and output window can be made side by side like any online ide

Addition of Mistakes/Shabbiness

Great work!

I'm not really sure how it is to be done, but it would be great if some mistakes and some amount of untidiness could be added on to the font as well! I don't think I need to explain why! πŸ˜„

Cheers!

[Bug]The Bug Report Template doesn't shows up when opening a new issue

Description

So when I created an issue there was no option to choose a bug report template though I can see a bug report template is present in the ISSUE TEMPLATES folder of this repo.

Screenshot

bug2

Possible fix

Maybe the bug report template hasn't been linked properly so we can check that out.

New UI and Home Page

We wish to have a new UI for the home page since the current one is not visually appealing and the code base is quite messed up

Certain Guidelines:

  • All commits are to be made in the beta_1 branch
  • Inline CSS and Internal CSS is not permitted
  • You can use Bootstrap or Materialize or Tailwind ( But do not use more than one framework)
  • All assets (i.e. images, illustrations,etc) are to be stored inside an assets/images/ directory of the beta_1 branch
  • You are expected to name the assets properly. Something like xybfg_grh1tgn_pic.png is not expected
  • Every Pull Request is expected to contain:
    - A relevant title
    - Screenshots of the changes/enhancements/bug fixes
    - Written Description of what you have done
    ** Additionally your code is expected to be documented with comments
    (GIFs for fun are welcome)
  • Please complete the part of the page you have taken and then only move to the next one
  • For repeatable elements in the page, let's say cards, something like insertion using JSON will be a great thing
  • Do not forget to optimize the assets
  • Since this is going to be a single page website (excluding our editor page), so all the CSS should be inside a style.css file and the HTML code inside the index.html file of the beta_1 branch
  • Use only Montserrat Font

A Rough Sketch of what we are looking at

Doc2Pen_Pencil_UI
Doc2Pen_Pencil_UI_2

Tasks that are required to be done:

  • Ensure Mobile Responsiveness ( Please do not claim this, it is expected as a part of your PRs, if there's an issue with some part of the website you can directly give a PR to fix it)
  • Navigation Bar ( For now please keep in mind we are working on a light theme)
  • Home Section
  • About Section ( I expect you to be creative here and add things beyond what I have given in the sketches)
  • Team Section
  • Contact Section
  • Footer ( This is the simplest one, nothing fancy required here)
  • Please ensure the color theme is consistent throughout the page and work with the mentors on the same
  • Additional tasks ( Can be done in parallel or after the above are done):
    - [ ] Search Engine Optimization ( One single PR with all relevant meta tags including og is expected. Do not forget to elaborate about the same on the description of your PR) Use GTMetrics/LightHouse to check performance
    - Website Optimization ( Code/Assets/Load Time)
    - Improved Animations
    - Improved Documentation

Feedback Form

Description:

we have to add feedback form so that our users give us valuable feedback and suggestions for new features

Screenshots:

SEO and other optimizations

  • Tweak the SEO of the project to ensure it's ranked #1 on Google Search and try to have some similar hack for GitHub
  • Optimize the assets
  • Improve the codebase

Issue with buttons on editor page

there is confusion between the button present on the editor page. We have to change the text on the button or change the UI design so that we are able to add more features and in future users clearly understand the functionality of buttons.
Screenshot (49)

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.