Skip to content

docs: enhance README #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
armand1m merged 4 commits into from
Oct 11, 2020
Merged

docs: enhance README #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cbfbf50
docs: enhance README
armand1m Oct 11, 2020
86e8fb6
fix: reamde
armand1m Oct 11, 2020
06eb90c
fix: readme usage
armand1m Oct 11, 2020
cc7d9a0
docs: add other impls
armand1m Oct 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/404.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/mainpage.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/redirect.gif
View file
Open in desktop
Binary file not shown.
29 changes: 23 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# golinks

<div style="max-width: 700px">
<img src="./.github/mainpage.png?raw=true">
</div>

**Mainpage**

<div style="max-width: 700px">
<img src="./.github/404.png?raw=true">
</div>

**404 with Link suggestions**

This application is deployed at https://go.d1m.dev. Signup is enabled for view only mode.

This is an implementation of Go Links powered by [Next.js](https://nextjs.org/), [GraphQL](http://graphql.org/) through [PostGraphile](https://www.graphile.org/postgraphile/) and [Auth0](https://www.auth0.com).
Expand All @@ -8,10 +20,6 @@ In short, Go Links are a type of URL Shorteners. You can create an alias that po

Please check the [Related](#related) section to have a glance on how other companies and universities leverage go links.

<div style="max-width: 700px">
<img src="./.github/mainpage.png?raw=true">
</div>

## Related

- [golinks.ncsu.edu](https://golinks.ncsu.edu/)
Expand All @@ -21,6 +29,13 @@ Please check the [Related](#related) section to have a glance on how other compa
- [The quick and simple guide to go links](https://www.trot.to/go-links)
- [Google's go link culture](https://yiou.me/blog/posts/google-go-link)

## Other implementations

- Open Source: [github/kellegous/go](https://github.com/kellegous/go)
- Open Source/Freemium: [trot.to](https://www.trot.to/)
- Freemium: [goatcodes.com](https://goatcodes.com/)
- Freemium: [golinks.io](https://golinks.io)

## Feature Checklist

These are just a few ideas that come in my mind.
Expand All @@ -38,13 +53,15 @@ Contributions for the following are very welcome.
- [x] Security
- [x] Row Level Security using Auth0 Roles and Permissions
- [ ] Link Description
- [ ] Link Suggestion on 404
- [x] Link Suggestion on 404
- [x] Link Usage Metrics
- [x] Number: Usage Total Count
- [x] Graph: Usage of last 14 days
- [x] Graph: Usage of last 31 days
- [ ] Link Ownership
- [ ] Link Parameters
- [ ] Link Groups (Folders)
- [x] URL: Accept `/` and can be redirected
- [ ] UI: Folds URL groups
- [ ] Private Links
- [ ] Temporary Links
- [ ] Random Alias
Expand Down