https://github.com/qqiao/yordle

A URL shortener service for Google Cloud Platform
https://github.com/qqiao/yordle

shorturl shorturl-services

Last synced: about 2 months ago
JSON representation

A URL shortener service for Google Cloud Platform

• Host: GitHub
• URL: https://github.com/qqiao/yordle
• Owner: qqiao
• License: gpl-2.0
• Created: 2019-05-10T18:36:25.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-07T00:20:28.000Z (almost 2 years ago)
• Last Synced: 2024-10-12T08:08:15.100Z (3 months ago)
• Topics: shorturl, shorturl-services
• Language: TypeScript
• Size: 6.41 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
Yordle Short URL service

========================

Prerequisites

-------------

To install Yordle, please make sure you have the following prerequisites:

1. A registered Google Cloud Platform project.

2. 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](https://cloud.google.com/appengine/docs/standard/go/download).

3. Google Cloud Datastore emulator. Documentations and installation guides are

   located [here](https://cloud.google.com/datastore/docs/tools/datastore-emulator).

4. `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](https://www.typescriptlang.org/).

Other Readings

--------------

- [Lit](https://lit.dev): Yordle's user interface framework.

- [Redux](https://redux.js.org/): Yordle's state management library.

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= 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= yarn deploy

Seeing is believing

-------------------

Visit https://yordle-demo.appspot.com to see Yordle working!