Giter Club home page Giter Club logo

docly's Introduction

docly

This was the first place submission at the Branham 2022 Hackathon.

Setup, Installation, Usage

Google API Setup

Create a new project in the Google Cloud Console. Make sure to enable the following APIs:

  • Google Docs
  • Google Drive
  • Cloud Vision

(For cloud vision it is necessary to link a credit card to the account. This can be done in the Billing section. If you are a new user you get a 90 day free trial so we did not pay anything.)

In the Credentials section of the project, create a service account for Cloud Vision and an OAuth client ID for Docs and Drive. In the OAuth client, add yourself as a test user, and add both http://localhost and http://localhost:1234 as authorized origins (the kind for the client, not the server).

Download the service account key to server/key.json. Replace the OAuth client ID in client/src/App.jsx with yours.

Set Up and Build Client

cd client
yarn install
yarn build

Set Up and Run Server

cd server
pipenv shell
# in the subshell:
pipenv install
GOOGLE_APPLICATION_CREDENTIALS="$(realpath key.json)" python backend.py

Use the Application

Navigate to http://localhost:1234. Log in with Google, then take an image, then submit. Open the created Google Doc link to see your result!

docly's People

Contributors

mattfbacon avatar seadeef avatar

Watchers

 avatar

docly's Issues

Avoid using low port numbers

Ports <~8080 are generally "dangerous" to use because of conflicts with other applications. 1234, the port you happened to use in this case IS above the 1024 system reserved port space, which is nice, but it is rather small.

I recommend picking a more standard port (like 8080) or one that isn't on this list: https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers.

Hope you resolve this soon because I am unable to use this due to VLC Media Player's default UDP/RTP stream being 1234.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.