Shortender
Nuxt + Tailwind + Supabase Link Shortener Shortender is a Nuxt.js project designed to provide URL shortening services.
Tech Stack :
Shortender
Shortender is a Nuxt.js project designed to provide URL shortening services. This README provides an overview of the project structure, installation instructions, and usage guidelines.
Project Structure
The project consists of the following main directories and files:
- : Git configuration to ignore specific files and directories.
- : Configuration file for npm.
- : Nuxt.js configuration file.
- : Auto-generated file that locks the versions of a project's dependencies.
- : Project metadata and dependencies.
- : Lockfile for pnpm dependencies.
- : Tailwind CSS configuration file.
- : TypeScript configuration file.
- : Lockfile for yarn dependencies.
Directories
- : Contains IDE-specific configurations.
- : Contains the Tailwind CSS file.
- : Contains Vue components such as , , , and .
- : Contains custom hooks like and .
- : Contains the default layout for the application.
- : Contains authentication middleware.
- : Contains the different pages of the application, including dynamic routes.
- : Contains static files like .
- : Contains TypeScript definitions for Supabase.
Installation
To set up the project locally, follow these steps:
-
Clone the repository:
-
Navigate to the project directory:
-
Install the dependencies:
-
Create a file in the root directory and fill in the necessary environment variables:
-
Start the development server:
Usage
Once the development server is running, you can access the application in your web browser at .
Contributing
If you would like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch ().
- Make your changes.
- Commit your changes ().
- Push to the branch ().
- Open a pull request.
License
This project is licensed under the MIT License. See the file for more details.