This repository has been archived by the owner on Aug 11, 2021. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
af71acc
commit f06314d
Showing
27 changed files
with
3,389 additions
and
417 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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]. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.