1. FEATURES
2. PREREQUISITES
3. SETUP
4. RUNNING THE SCRIPT
5. ERROR HANDLING
6. HOSTING
7. USED PACKAGES
8. TOOLS
9. ARTICLES
10. DO NOT FORGET TO DO
11. TUTORIALS
12. INSPIRATIONS
13. CONTRIBUTE
14. CONTRIBUTORS
15. SPECIAL THANKS
16. LICENSE
17. CONTACT

1. Create short URL
2. Redirect to the original URL
3. QR code
4. URL Analytics

1. Node v18
2. PNPM v10

1. Clone the repository and navigate to the directory:

   git clone https://github.com/montasim/quillink.git
   cd quillink

2. Install the dependencies:

   pnpm install

3. Configuring the Environment:

   Create a .env.development or .env.staging or .env.production file in the root directory of the project and populate it with the necessary environment variables. See the .env.example file for an example.

1. Running the Application:

   To start the application in development mode, use:

   pnpm dev

   This will run the server with nodemon, automatically restarting when any changes are made.

2. To build the application, use:

   pnpm build

   This will build the application.

3. To run the application, use:

   To run the application, use:

   pnpm start

   This will run the project.

4. Code Prettier:

   • To check if files are formatted correctly:

     pnpm prettier:check

   • To format files:

     pnpm prettier:fix

Docker

1. Build the Docker Compose Services:

   pnpm docker:build-dev

2. Run the Docker Compose Services:

   pnpm docker:run-dev

3. Stop the Containers:

   pnpm docker:stop-dev

4. Rebuild the Containers:

   pnpm docker:rebuild-dev

Step-by-step guide on setting up your own Vercel instance:

Vercel is the recommended option for hosting the files since it is free and easy to set up.

1. Go to vercel.com.
2. Click on Log in.
3. Sign in with GitHub by pressing Continue with GitHub.
4. Sign in to GitHub and allow access to all repositories if prompted.
5. Fork this repo.
6. Go back to your Vercel dashboard.
7. To import a project, click the Add New... button and select the Project option.
8. Click the Continue with GitHub button, search for the required Git Repository and import it by clicking the Import button. Alternatively, you can import a Third-Party Git Repository using the Import Third-Party Git Repository -> link at the bottom of the page.
9. Create a personal access token (PAT) here and enable the repo and user permissions (this allows access to see private repo and user stats).
10. Copy all the .env.development file as environment variables in the Vercel dashboard.
11. Click deploy, and you're good to go. See your domains to use the API!

1. WebStorm
2. Postman
3. Swagify.io

Contributions are always welcome! Please read the contribution guidelines and contributor license agreement.