README
¶
uploader
A command line interface (CLI) for uploading articles from Google Drive Volume folders to our Rails API.
Setup
You must have an admin account (security level > 0) in the database to be able to use the uploader. Put the credentials to the account in a dotenv file like so:
EMAIL=YOUR_EMAIL
PASSWORD=YOUR_PASSWORD
Usage
# Compile program and create binary
$ go install
# Run bulk upload for Volume 108 Issue 11
$ uploader -m 108 -i 11
For specific instructions on how to clean Issue folders for uploading (a must for every issue), please visit the UPLOADING.md file.
Optional flags
- --window, -w: open core files when bulk uploading (e.g. Photo/Art folders, Newspaper PDF)
- --local PORT, -l PORT: use a locally hosted GraphQL server
Roadmap
For information on the things which are currently being focused on, please visit the ROADMAP.md file.
Troubleshooting
For troubleshooting instructions, please visit the TROUBLESHOOTING.md file.
Documentation
¶
Overview ¶
uploader is a command line application that assists the automatic uploading of articles of The Stuyvesant Spectator.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package driveclient contains useful functions for creating and interacting with the Drive client API.
|
Package driveclient contains useful functions for creating and interacting with the Drive client API. |
|
Package graphql provides a GraphQL client to the Spectator Rails API.
|
Package graphql provides a GraphQL client to the Spectator Rails API. |
|
Package log contains useful utilities for color print(f)ing.
|
Package log contains useful utilities for color print(f)ing. |
|
Package parser implements functions to parse the text of Spectator articles.
|
Package parser implements functions to parse the text of Spectator articles. |
|
patterns
Package patterns provides regular expressions and pattern-matching utils.
|
Package patterns provides regular expressions and pattern-matching utils. |
Click to show internal directories.
Click to hide internal directories.