Quickstart

Tutorial for getting started with ishortn

Setup your development

To run the project locally or deploy it to your own server, you’ll need to go through the following steps in the documentation.

Services that we depend on

• MySQL - Database
• Redis - Cache
• Vercel - Hosting
• Coolify - Hosting
• Clerk - Authentication
• Docker - Containerization

Technologies used

• Next.js - React Framework
• TailwindCSS - CSS Framework
• Bun - Package Manager
• Prisma - ORM
• Typescript - Programming Language
• Shadcn - TailwindCSS components

Clone the repository

Clone the repository

The repository is found on Github. Since you are reading this section of the document you probably have the required software installed to clone the repository. (git, node)

git clone https://github.com/AmoabaKelvin/ishortn.git

Install dependencies

The project uses bun as the package manager and depends on a few other packages.

To install the dependencies run the following command in the root directory of the project.

bun install

Setup environment variables

You can find the environment variables in the .env.example file. Create a .env file and copy the contents of the .env.example file into it. Then fill in the required values with the correct values you get from the services we are using.

Please keep the .env file at the root of the project.

Run the project

Start the development server

By completing the above steps you should be able to run the project locally. To start the development server run the following command in the root directory of the project.

bun run d