Skip to content
This repository has been archived by the owner on Aug 11, 2021. It is now read-only.

Commit

Permalink
refactor and update with master
Browse files Browse the repository at this point in the history
  • Loading branch information
saurabhdaware committed May 10, 2020
1 parent af71acc commit f06314d
Show file tree
Hide file tree
Showing 27 changed files with 3,389 additions and 417 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: End-to-end tests
on: [push]
jobs:
cypress-run:
runs-on: ubuntu-16.04
steps:
- name: Checkout
uses: actions/checkout@v1
# Install NPM dependencies, cache them correctly
# and run all Cypress tests
- name: Cypress run
uses: cypress-io/github-action@v1
with:
start: npm run dev
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules/
# Add .npmrc when you have multiple node binaries.
.npmrc
21 changes: 18 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
# Contribution Guide
# Contribution Guide 🌻
The project is built with basic web setup (HTML, CSS, and JavaScript) without any bundlers.

## Local Setup
## 🐨 Local Setup
- [Fork](https://github.com/saurabhdaware/text-to-handwriting/fork) this repository.
- Clone your fork `git clone https://github.com/:yourusername/text-to-handwriting`
- Open folder `text-to-handwriting` and open `index.html` with browser. (Or you can use any npm module to run static server).
- Open folder `text-to-handwriting` and run `index.html` with a [static server](#-run-local-static-server).

## 💻 Run Local Static Server
- There are npm packages like [serve] that help you in creating static server.
- You can `npm install -g serve` to install serve
- Then from project's directory, You can run `serve .` to run a static server.

## 🤗 Hello First-time Contributors
There are lot of resources (articles, courses, videos) available for getting started with git and GitHub you can search and follow any of the resource you like.

- You can pick any of the issues from [Issues](https://github.com/saurabhdaware/text-to-handwriting/issues) or If you feel like it needs extra feature or if you find bug, you can create your own issue.
- You can drop a comment on issue saying "Hi Saurabh, let me work on this or I will kill you 🔪" to avoid multiple people working on the same PR.

Lastly, It is fine if you mess something up. If there is anything wrong in the PR I will let you know how to fix that in comments of the PR.

If you are still scared to drop a PR or need any help, you can always drop me a message on my [Twitter @saurabhcodes](https://twitter.com/saurabhcodes) or drop me an email at [email protected].
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 Saurabh Daware

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
23 changes: 7 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,16 @@
# Text-to-Handwriting
<p align="center">
<img alt="Text-to-handwriting title image" src="https://res.cloudinary.com/saurabhdaware/image/upload/w_400/v1586015094/saurabh2019/text-to-handwriting-title.png" />
<br/><b><a href="https://saurabhdaware.github.io/text-to-handwriting/">https://saurabhdaware.github.io/text-to-handwriting/</a></b><br/><br/><img alt="NPM Version" src="https://img.shields.io/github/package-json/v/saurabhdaware/text-to-handwriting?style=flat-square" /> <a href="#contributing"><img alt="Contributions Welcome" src="https://img.shields.io/badge/contributions-welcome-brightgreen?style=flat-square"></a> <img alt="GitHub License MIT" src="https://img.shields.io/github/license/saurabhdaware/text-to-handwriting?style=flat-square"> <a href="https://twitter.com/saurabhcodes"><img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/saurabhcodes?style=social"></a><br/><br/> I hate writing assignments so I made this tool that converts text to an image that looks like handwriting😛

Hey everyone! I hope the person who is reading this is not my teacher.

I hate writing assignments so I made this tool that converts text to an image that looks like handwriting with background of a paper😛
</p>

**Link:** https://saurabhdaware.github.io/text-to-handwriting/

Also, I am trying to make this look more realistic and I would love to have people contribute in it🌻

## This is how output will look
## 🌠 Output
![Sample image of output](sample.jpeg)



## How to add your own handwriting?
- To use your handwriting, you will have to generate font of your handwriting.
- You can do that using [Calligraphr](https://www.calligraphr.com/en/)
- Once you get .ttf file of your handwriting, just upload it from upload button and boom! you will have your handwriting in the image.


## Contributing
## 🤗 Contributing

Checkout [Contribution Guide](CONTRIBUTING.md) for local setup and contribution guide.

Expand All @@ -30,4 +21,4 @@ Checkout [Contribution Guide](CONTRIBUTING.md) for local setup and contribution


bye!
Have fun 🦄
Have fun 🦄
Loading

0 comments on commit f06314d

Please sign in to comment.