Shorty requires Node and Yarn.
# Setup a local repository
git clone https://github.com/TIHLDE/shorty.git
cd shorty
# If this is your first time running the application
yarn
# Thats it!
From now on it's enough to run yarn dev to run the application.
Shorty is a short-link service created to handle the SEO-problem with SPA's. The events, news, jobposts and pages on tihlde.org have their own short link on shorty with Open Graph-metadata which improves the look when shared on social media. Shorty is hosted on s.tihlde.org which gives us these beatiful URL's:
- Events: https://s.tihlde.org/a/[id]/
- Jobposts: https://s.tihlde.org/k/[id]/
- News: https://s.tihlde.org/n/[id]/
- Pages: https://s.tihlde.org/om/[slug]/
In addition, members of TIHLDE have access to create their own custom short-links with the URL: https://s.tihlde.org/[slug]
The TIHLDE shorty-service is an open source project build on voluntary work. We are committed to a fully transparent development process and highly appreciate any contributions. Whether you are helping us fixing bugs, proposing new feature, improving our documentation or spreading the word - we would love to have you as part of the community.
Feel free to file a new issue with a respective title and description on the the TIHLDE/shorty repository. If you already found a solution to your problem, we would love to review your pull request! Please format your code with prettier. If you open the workspace-file in VSCode, the code will be formatted automatically on save.
Feel free to send us a message on our official slack channel. Of course you can always reach out to us directly at [email protected].
The code in this project is licensed under MIT license.