> ## Documentation Index
> Fetch the complete documentation index at: https://ishortn.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](https://www.mysql.com/) - Database
* [Redis](https://redis.io/) - Cache
* [Vercel](https://vercel.com/) - Hosting
* [Coolify](https://coolify.io/) - Hosting
* [Clerk](https://clerk.dev/) - Authentication
* [Docker](https://www.docker.com/) - Containerization

## Technologies used

* [Next.js](https://nextjs.org/) - React Framework
* [TailwindCSS](https://tailwindcss.com/) - CSS Framework
* [Bun](https://bun.sh/) - Package Manager
* [Prisma](https://www.prisma.io/) - ORM
* [Typescript](https://www.typescriptlang.org/) - Programming Language
* [Shadcn](https://ui.shadcn.com/) - TailwindCSS components

## Clone the repository

<AccordionGroup>
  <Accordion icon="github" title="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)

    ```bash theme={null}
    git clone https://github.com/AmoabaKelvin/ishortn.git
    ```
  </Accordion>

  <Accordion icon="rectangle-terminal" title="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.

    ```bash theme={null}
    bun install
    ```
  </Accordion>

  <Accordion icon="rectangle-terminal" title="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.
  </Accordion>
</AccordionGroup>

## Run the project

<AccordionGroup>
  <Accordion icon="rocket" title="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.

    ```bash theme={null}
    bun run d
    ```
  </Accordion>
</AccordionGroup>