https://github.com/waxer59/smll

URL shortener with innovative features.
https://github.com/waxer59/smll

appwrite smll url-shortener

Last synced: 25 days ago
JSON representation

URL shortener with innovative features.

• Host: GitHub
• URL: https://github.com/waxer59/smll
• Owner: Waxer59
• License: mit
• Created: 2024-05-12T19:59:25.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-12-15T16:46:19.000Z (about 2 months ago)
• Last Synced: 2024-12-15T17:32:47.914Z (about 2 months ago)
• Topics: appwrite, smll, url-shortener
• Language: TypeScript
• Homepage: https://smll.app
• Size: 305 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Smll



## How to run the project?

1. Install all the dependencies with the command:

```bash

pnpm i

```

2. Rename the file `.template.env` to `.env` and fill the fields.

    - `APPWRITE_API_KEY` - api key of the appwrite project

    - `NEXT_PUBLIC_APPWRITE_PROJECT_ID` - project id of the appwrite project

    - `NEXT_PUBLIC_APPWRITE_ENDPOINT` - endpoint of the appwrite project

    - `NEXT_PUBLIC_BASE_URL` - the base url of the project

    - `NODE_ENV` - development | production | test (default: development)

    - `JWT_SECRET` - random string

3. Run the project with the command:

```bash

pnpm dev

```

## Technologies used

* [Next.js](https://nextjs.org/)

* [TypeScript](https://www.typescriptlang.org/)

* [Tailwind CSS](https://tailwindcss.com/)

* [Mantine](https://mantine.dev/)

* [react-qrcode-logo](https://github.com/gcoro/react-qrcode-logo)

* [Appwrite](https://appwrite.io/)

* [Lucide](https://lucide.dev/)

* [Sonner](https://github.com/emilkowalski/sonner)

* [Vitest](https://vitest.dev/)