Skip to content
This repository has been archived by the owner on Aug 13, 2024. It is now read-only.

Latest commit

 

History

History
48 lines (33 loc) · 2.36 KB

README.md

File metadata and controls

48 lines (33 loc) · 2.36 KB
Raw

microurl

A personal url shortener and code snippet sharing tool

Run on Google Cloud

Overview

microurl is an url shortener and a code snippet sharing tool with an ASP.NET Core backend and an Angular frontend. It was designed to work with Google Cloud Run and stores all data in Google Cloud Datastore (though other data source might be supported too in the future).

To edit code snippets it currently uses Monaco Editor and in order to guarantee faster load times and a better user experience (especially on mobile), microurl can also be installed as a PWA.

Configuration

  1. Setup Authentication for Google Cloud Datastore (run gcloud auth application-default login)
  2. Edit src/MicroUrl.Web/Properties/launchSettings.json and update GCP_PROJECT to your Google Cloud project and ANALYTICS_ID to your Google Analytics ID.
  3. Apply indicies using the applyIndicies.sh script

Run microurl locally

  1. dotnet build
  2. Configure microurl
  3. dotnet run --project src/MicroUrl.Web
  4. microurl should now be running on localhost:8080

License

MIT License

Copyright (c) 2019 Thomas Gassmann

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.