mirror of
https://github.com/Xevion/power-math.git
synced 2025-12-06 05:15:56 -06:00
update README, add yarn lock & package.json
This commit is contained in:
53
README.md
53
README.md
@@ -1,38 +1,23 @@
|
||||
# calligraphy
|
||||
# power-math
|
||||
|
||||
`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.
|
||||
I'm not as quick with simple numerical math as I like, so I designed this.
|
||||
|
||||
## Design
|
||||
**power-math** is a project dedicated to those who want to practice random math problems from simple arithmetic to geometry, algebra, or trigonometry.
|
||||
|
||||
- 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
|
||||
### To-do
|
||||
|
||||
## 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/).
|
||||
- Create logo
|
||||
- Transition off of Python backend
|
||||
- Create new javascript question generation
|
||||
- Create more problems
|
||||
- Add question answering & validation
|
||||
- Decide method of showing it
|
||||
- Checkmark
|
||||
- Edge flash
|
||||
- Toast
|
||||
- Remember statistics
|
||||
- Milestone toasts
|
||||
- Problem difficulty variation
|
||||
- Variable multiplier
|
||||
- Time limit
|
||||
- Customizable question type pool
|
||||
|
||||
7
package.json
Normal file
7
package.json
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"dependencies": {
|
||||
"axios": "^0.21.0",
|
||||
"katex": "^0.12.0",
|
||||
"vue-katex": "^0.5.0"
|
||||
}
|
||||
}
|
||||
39
yarn.lock
Normal file
39
yarn.lock
Normal file
@@ -0,0 +1,39 @@
|
||||
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
||||
# yarn lockfile v1
|
||||
|
||||
|
||||
axios@^0.21.0:
|
||||
version "0.21.0"
|
||||
resolved "https://registry.yarnpkg.com/axios/-/axios-0.21.0.tgz#26df088803a2350dff2c27f96fef99fe49442aca"
|
||||
integrity sha512-fmkJBknJKoZwem3/IKSSLpkdNXZeBu5Q7GA/aRsr2btgrptmSCxi2oFjZHqGdK9DoTil9PIHlPIZw2EcRJXRvw==
|
||||
dependencies:
|
||||
follow-redirects "^1.10.0"
|
||||
|
||||
commander@^2.19.0:
|
||||
version "2.20.3"
|
||||
resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33"
|
||||
integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==
|
||||
|
||||
deepmerge@^4.2.2:
|
||||
version "4.2.2"
|
||||
resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-4.2.2.tgz#44d2ea3679b8f4d4ffba33f03d865fc1e7bf4955"
|
||||
integrity sha512-FJ3UgI4gIl+PHZm53knsuSFpE+nESMr7M4v9QcgB7S63Kj/6WqMiFQJpBBYz1Pt+66bZpP3Q7Lye0Oo9MPKEdg==
|
||||
|
||||
follow-redirects@^1.10.0:
|
||||
version "1.13.0"
|
||||
resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.13.0.tgz#b42e8d93a2a7eea5ed88633676d6597bc8e384db"
|
||||
integrity sha512-aq6gF1BEKje4a9i9+5jimNFIpq4Q1WiwBToeRK5NvZBd/TRsmW8BsJfOEGkr76TbOyPVD3OVDN910EcUNtRYEA==
|
||||
|
||||
katex@^0.12.0:
|
||||
version "0.12.0"
|
||||
resolved "https://registry.yarnpkg.com/katex/-/katex-0.12.0.tgz#2fb1c665dbd2b043edcf8a1f5c555f46beaa0cb9"
|
||||
integrity sha512-y+8btoc/CK70XqcHqjxiGWBOeIL8upbS0peTPXTvgrh21n1RiWWcIpSWM+4uXq+IAgNh9YYQWdc7LVDPDAEEAg==
|
||||
dependencies:
|
||||
commander "^2.19.0"
|
||||
|
||||
vue-katex@^0.5.0:
|
||||
version "0.5.0"
|
||||
resolved "https://registry.yarnpkg.com/vue-katex/-/vue-katex-0.5.0.tgz#af178cc50932847ce2be28e2a35c30246e890e32"
|
||||
integrity sha512-KsjSK4ftpw9q8SP1OJbigPOozdthOS46+6GmqkToXZVmmPejBHGGmDUxJ/2UtkyAuHf5dHL+2RvOXi/RV77YOA==
|
||||
dependencies:
|
||||
deepmerge "^4.2.2"
|
||||
Reference in New Issue
Block a user