https://github.com/gs256/outshort
A simple link shortener
https://github.com/gs256/outshort
angular gin gin-gonic go golang link-shortener primeng shortener
Last synced: 5 months ago
JSON representation
A simple link shortener
- Host: GitHub
- URL: https://github.com/gs256/outshort
- Owner: gs256
- Created: 2025-02-21T19:14:07.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-10-26T17:15:41.000Z (6 months ago)
- Last Synced: 2025-10-26T19:18:37.969Z (6 months ago)
- Topics: angular, gin, gin-gonic, go, golang, link-shortener, primeng, shortener
- Language: TypeScript
- Homepage:
- Size: 442 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Outshort
**Simple link shortener web application**
## About
### Stack
- **Frontend framework:** Angular 19
- **Styles:** PrimeNG 19 + Tailwind 3.4
- **Server:** Go + Gin
- **Database:** SQLite
## Quickstart
### Dependencies
- `go`
- `goose` ([go package](https://github.com/pressly/goose))
- `docker` (recommended)
### Setup environment
Data inside `server/env` directory and `server/.env` file (TODO) are meant to be stored and modified outside the server container and mounted using volumes
```sh
$ cp server/.env.template server/.env
# TODO: additional configuration
```
### Initialize database
If you are running the project for the first time you need to initialize sqlite3 database and apply migrations using `goose`. This database will be stored locally and passed to the server container
```sh
$ cd server
# Run goose go initialize database
$ go run github.com/pressly/goose/v3/cmd/goose@latest up
```
This will generate a `server/env/database.db` file with the latest schema
### Build and run
```sh
# Setup permissions
$ sudo chmod +x ./scripts/local-deploy.sh
# Build client and server containers and run them
$ ./scripts/local-deploy.sh
```
This will create a copy of the development environment inside the `deploy` directory
## Development
**Start server**
```sh
$ cd server
$ go run .
```
**Start client**
```sh
$ cd client
# Install dependencies
$ npm i
$ npm start
```
After that open `http://localhost:4200` in your browser
## License
MIT