Oca is a very simple URL shortener, with a user-first design, and simple to deploy.
- Analytics for all shortened URLs (planned)
- User accounts for managing URLs (planned)
- Custom aliases for short URLs
- Node.js
- MySQL database, or any variant
- All required dependencies in the package.json file
This application will require you to set a few environment variables in order to function properly.
| Variable | Data type | Example | Description |
|---|---|---|---|
| APP_DOMAIN | string | oca.li |
Domain which the app will use |
| APP_NAME | string | Oca |
Name of the app, e.g. "Mini". This will be displayed on page titles, content, etc. |
| APP_TAGLINE | string | A URL shortener |
Shows next to the app icon, leave blank to hide tagline |
| DATABASE_URL | string | mysql://root@localhost/db |
URL that points to your database |
- Run
npm install, this will install all the dependencies. - Set up all the environment variables specified in the Configuration variables section.
- Find a short domain to use for the app.
- Start the server by running
npm start.