README
¶
Yordle Short URL service
Prerequisites
To install Yordle, please make sure you have the following prerequisites:
- A registered Google Cloud Platform project.
- The most recent version of Google App Engine Go SDK and all its dependencies. Instructions on how to obtain the SDK can be found here.
- Google Cloud Datastore emulator. Documentations and installation guides are located here.
yarn. You can install the latest version of them by using the command:npm install -g yarn
Please note that this project can also be built with npm. Please search and
replace all instances of yarn with npm in the package.json file.
Yordle assumes knowledge of Google Cloud Platform, specifically the App Engine Go runtimes, and the Go programming language. You can visit https://cloud.google.com/appengine for information on Google App Engine and https://go.dev for information on the Go programming language.
The user interface of Yordle is written in TypeScript.
Other Readings
Getting Yordle
Yordle is set up as a go module, thus simplying cloning this repository should work for users with Go versions supporting modules, in other words Go > 1.11.
Working with Yordle
Running locally
Running the following commands will launch Yordle locally.
cd $CHECKOUT_DIR
yarn install
CLOUDSDK_CORE_PROJECT=<project_id> yarn start
You can then edit and test your application by visiting http://localhost:8080.
TypeScript changes will be reflected upon the next browser refresh. Go changes, however, will require killing the current running instances and restarting.
Deploying to Google App Engine
Please ensure that you have correctly setup your Google Cloud SDK user authentication.
You can then deploy the application by running:
cd $CHECKOUT_DIR
yarn install
CLOUDSDK_CORE_PROJECT=<project_id> yarn deploy
Seeing is believing
Visit https://yordle-demo.appspot.com to see Yordle working!
Documentation
¶
Overview ¶
Package yordle is URL shortener that is designed to work on the Google App Engine platform.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package admin provides UI endpoints for admin functionality of Yordle.
|
Package admin provides UI endpoints for admin functionality of Yordle. |
|
Package api provides RESTful API for CRUD operations of short URLs.
|
Package api provides RESTful API for CRUD operations of short URLs. |
|
Package config provides configuration information of the Yordle application and helper methods for loading and saving configuration parameters.
|
Package config provides configuration information of the Yordle application and helper methods for loading and saving configuration parameters. |
|
Package shorturl provides functionality for the basic CRUD operations.
|
Package shorturl provides functionality for the basic CRUD operations. |