basic repository files (ignore, README, python requirements)

This commit is contained in:
Xevion
2020-08-27 01:33:08 -05:00
parent 1596518757
commit 49de7dbd3d
3 changed files with 186 additions and 0 deletions

38
README.md Normal file
View File

@@ -0,0 +1,38 @@
# calligraphy
`calligraphy` is a project made to generate calligraphy practice sheets. Each sheet generated
focuses on a specific font (provided by Google Fonts), allowing users to download dynamically
generated sheets on the fly.
## Design
- Pages are dynamically generated by the browser. No backend needed.
- Fonts are dynamically fetched and loaded from Google's Font API
- Fonts are converted to base64 and placed in the PDF as needed.
- Page sentences can be dynamically generated as needed, or typed in by users
- Customizable
- Font Family
- Font Color
- Font Opacity
- Font Size
- Guideline Opacity
- Guideline Color
- Guideline Style
## Method
Vue.js is used to manage all of the UI. Material Design is the CSS framework used to design this
web application.
## Local Deployment
- Project setup
- `npm install`
- Compiles and hot-reloads for development
- `npm run serve`
- Compiles and minifies for production
- `npm run build`
- Lints and fixes files
- `npm run lint`
- Customize configuration
- See [Configuration Reference](https://cli.vuejs.org/config/).