Skip to content

notnavindu/kotaa

Repository files navigation

Contributors Forks Stargazers Issues MIT License Hits


Logo

Kotaa

Self-hostable, Personal URL Shortner That Lives on The Edge

View Demo · Report Bug · Request Feature

About The Project

Product Name Screen Shot

Kotaa is a simple, personal, self-hostable URL shortner that can be deployed to the Vercel Edge network.

(back to top)

Built With

  • SvelteKit
  • Redis (Upstash)
  • Supabase (For authentication)
  • Vercel Edge Network

(back to top)

Examples

Getting Started

Environment Variables

PUBLIC_SUPABASE_URL: This can be found in the "API" section of your Supabase project's settings PUBLIC_SUPABASE_ANON_KEY: This can be found in the "API" section of your Supabase project's settings PUBLIC_ALLOWED_EMAILS: Comma separated email address list which are allowed to access the dashboard. (Do not keep any spaces) e.g: john@gmail.com,jane@gmail.com

The following values in the .env file will be auto filled if you are deploying directly to vercel. If not, you need to setup a project on Upstash and copy these values from the dashboard.

Vercel Deploy

Easiest way to get up and running with Kotaa

Deploy with Vercel

Manual Installation

If you don't like the blue Vercel "deploy" button.

  1. Fork & Clone
  2. Run npm install
  3. Copy .env.example and rename it to .env
  4. Add your upstash environment variables
  5. supabase setup
    1. Create an account or login to your supabase account
    2. Add PUBLIC_SUPABASE_URL and PUBLIC_SUPABASE_ANON_KEY values into the .env file. (You can get these values from supabase)
  6. upstash setup
    1. Create a new project on upstash and you can find the env variables required for upstash from the upstash dashboard.
    2. Copy those over to your local .env file
  7. Push and deploy the project to vercel. (Remember to add your environment variables!)
  8. Add a custom domain to your vercel project (like link.navindu.me) and you're good to go!

(back to top)

License

Distributed under the GPL-3.0 License.

(back to top)

Contact

Feel free to contact me via hello@navindu.me or through my twitter link.navindu.me/twitter

(back to top)