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

147
.gitignore vendored Normal file
View File

@@ -0,0 +1,147 @@
# Repository specific
.vscode/**
.idea/**
migrations/**
app.db
keys.json
app.db-journal
test.html
app/data/raw/*.html
app/data/preprocess/*.json
flaskenv
algolia.json
*.scss.css
*.scss.css.map
node_modules/**
server/data/algolia/**
server/data/html/**
server/data/processed/**
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
.python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/

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/).

1
requirements.txt Normal file
View File

@@ -0,0 +1 @@
flask