https://github.com/mcgrimtv/link-shortener
A lightweight, open-source custom link shortener built with Node.js and PostgreSQL, designed for easy deployment on Railway using your custom domain.
https://github.com/mcgrimtv/link-shortener
bitly-alternative custom-links link-shortener postgresql railway short-link
Last synced: 2 months ago
JSON representation
A lightweight, open-source custom link shortener built with Node.js and PostgreSQL, designed for easy deployment on Railway using your custom domain.
- Host: GitHub
- URL: https://github.com/mcgrimtv/link-shortener
- Owner: McGRiMTV
- License: mit
- Created: 2026-04-24T03:14:44.000Z (2 months ago)
- Default Branch: prod
- Last Pushed: 2026-04-30T22:56:59.000Z (2 months ago)
- Last Synced: 2026-05-01T00:24:30.130Z (2 months ago)
- Topics: bitly-alternative, custom-links, link-shortener, postgresql, railway, short-link
- Language: EJS
- Homepage: https://mcgrim.dev
- Size: 26.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Atlas Link Shortener
A lightweight, open-source custom link shortener built with Node.js and PostgreSQL, designed for easy deployment on Railway using your custom domain.
## Getting Started
### Architecture
* **Frontend:** EJS (Server-side rendered HTML/CSS)
* **Backend API:** Node.js / Express
* **Database:** PostgreSQL
* **Domain:** Your custom domain `e.g., go.yourdomain.com` (Routed through Cloudflare)
#### 1. Database Setup
1. Create a new PostgreSQL database instance in your Railway project (or your own SQL).
2. Connect to your new database using the Railway CLI or a tool like pgAdmin/DBeaver.
3. Run the following SQL command to create the necessary table structure:
```sql
CREATE TABLE links (
id SERIAL PRIMARY KEY,
short_code VARCHAR(50) UNIQUE NOT NULL,
long_url TEXT NOT NULL,
clicks INTEGER DEFAULT 0,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
is_protected BOOLEAN DEFAULT FALSE,
password VARCHAR(255)
);
```
#### 2. Railway Deployment*
1. Fork or clone this repository and deploy it via the [Railway dashboard](https://railway.com/dashboard)\*\*.
2. In your Railway Project Settings, navigate to the **Variables** tab.
3. Add the following environment variables\*\*\*:
| Variable | Value Description |
| :--- | :--- |
| `DATABASE_URL` |The connection string for your PostgreSQL database (Railway provides this automatically via `${{ Postgres.DATABASE_URL }}` ). |
| `ADMIN_USER` | Your desired username for the admin dashboard. |
| `ADMIN_PASS` | Your secure password for the admin dashboard. |
| `SESSION_SECRET` | A randomized string used to encrypt session cookies ([Generate a Secret](https://api.madebyatlas.dev/password?length=40)). |
| `NODE_ENV` | Set this to `production` to enable secure cookies. |
*\*Other deployment options are possible, Railway is just suggested for ease.*
*\*\*Railway will automatically install the necessary NPM dependencies during the build phase.*
*\*\*\*For deployment elsewhere you can use a standard `.env` file and insert the variables as such (e.g. `ADMIN_PASS=SuperSecretPassword`, etc).*
#### 3. Usage & Configuration
1. Go to `https://go.yourdomain.com/`
2. Log in using the ADMIN_USER and ADMIN_PASS you configured in Railway.
3. Create your custom shortlinks directly from the dashboard. (e.g., creating the custom name `website` will map `https://go.yourdomain.com/website` to your destination URL).
## Change Log
[View Change Log](CHANGELOG.md)
## Support
For support regarding this repository please join the [Atlas Development Discord Server](https://discord.gg/atlasdev)
### Bug Reporting
Please join the Discord server linked above and submit a bug via the `#bugs` forum.
## License
This project is licensed under the MIT License.
This is a permissive license with conditions only requiring preservation of copyright and license notices.
Licensed works, modifications, and larger works may be distributed under different terms and without source code.
The license is viewable [here](LICENSE).
## Authors
**McGRiM** • [Website](https://mcgrim.dev) | [GitHub](https://github.com/McGRiMTV)
**Atlas Development** • [Website](https://madebyatlas.dev) | [GitHub](https://github.com/madebyatlas) | [Discord](https://discord.gg/atlasdev) | [Terms of Use](https://madebyatlas.dev/terms) | [Privacy Policy](https://madebyatlas.dev/privacy)
Copyright (c) 2026,
McGRiM / Atlas Development
All rights reserved.