Skip to content

Latest commit

 

History

History
89 lines (70 loc) · 3.44 KB

README.md

File metadata and controls

89 lines (70 loc) · 3.44 KB
Raw

jadeocr-next

Elegant spaced-repetition flashcards with handwriting for learning languages

An improved version of jadeocr, built with Vue3 and TypeScript

Stack

  • Vue3 + TypeScript
  • Node.js + Express

Docs

Take a look at the documentation site for the information below and an API reference.

Quickstart

First clone this repo, then set up your environment variables in client/.env

VUE_APP_API_BASEURL="my_server_url/api"

Then run the following to quickly spin up a dev instance

Super Fast Quickstart (Vim + Tmux)

chmod +x ./tmux-workspace.sh # only needs to be run first time
./tmux-workspace.sh

Client

cd client
yarn && yarn twbuild
yarn serve # Starts dev server on http://localhost:8080

Server

First set up a MongoDB server (locally or on MongoDB Atlas) then add the following to server/.env

MONGOOSEURL="my_mongoose_url_with_key"

On the server, make sure you have Python3 and TensorFlow Lite installed. Also make sure that you have installed virtualenv (pip install virtualenv) to isolate dependencies from the rest of your system. Then run the following

cd server

# Python setup
virtualenv venv # Creates python virtual environment
source venv/bin/activate # Activates virtual environment (run each time before working with the server)
pip install --upgrade pip # Updates pip
pip install -r requirements.txt # Installs dependencies

# Start up node.js server
cd server
yarn && yarn dev # Starts dev server on http://localhost:3000

deactivate # Deactivates virtual environment (run this when you're done)

If there are problems with ocr change the name of the python command in server/src/app.ts:14

Default ports (for deployment)

  • Client on port 8080
  • Server on port 3000
  • OCR web server on port 5000

Contribute

Thank you for reading this far and considering contributing! Contributions are very much appreciated, and they are what makes this project what it is! We are looking for contributions of features/feature requests, bug fixes, documentation fixes, and anything else you can think of! The best contributions are those that will add value to the user experience. If you need to get in touch, please see the contact/help section.

Issues

Browse through the issues or submit one. Here are a couple guidelines to follow:

  • Make sure all of your dependencies are up to date
  • Include steps to reproduce the issue
  • Expected behavior and what went wrong
  • Screenshots/terminal output if necessary

Pull Requests

Pull requests are also always welcome. Here are a couple simple guidelines:

  • Make sure your code is readable and commented when necessary
  • Try to adhere to this style guide
  • For the web client, make sure to lint your code before submitting a pull request by running yarn lint
  • Document your changes adequately when opening a pull request

Thank you so much for taking the time to contribute!

Contact/Help

If you would like to get in touch with me for any legitimate reason, please send me an email!

License

This repository is licensed under the MIT License.

Tanay Biradar
Jeremy