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:

• .gitignore: Git configuration to ignore specific files and directories.
• .npmrc: Configuration file for npm.
• nuxt.config.ts: Nuxt.js configuration file.
• package-lock.json: Auto-generated file that locks the versions of a project's dependencies.
• package.json: Project metadata and dependencies.
• pnpm-lock.yaml: Lockfile for pnpm dependencies.
• tailwind.config.js: Tailwind CSS configuration file.
• tsconfig.json: TypeScript configuration file.
• yarn.lock: Lockfile for yarn dependencies.

Directories

• .idea: Contains IDE-specific configurations.
• assets/css: Contains the Tailwind CSS file.
• components: Contains Vue components such as Header.vue, LinkItem.vue, Notification.vue, and NotificationManager.vue.
• composables: Contains custom hooks like useExternalRedirect.ts and useNotification.ts.
• layouts: Contains the default layout for the application.
• middleware: Contains authentication middleware.
• pages: Contains the different pages of the application, including dynamic routes.
• public: Contains static files like favicon.ico.
• types: Contains TypeScript definitions for Supabase.

Installation

To set up the project locally, follow these steps:

1. Clone the repository:

   git clone <repository_url>
   

2. Navigate to the project directory:

   cd <repository_directory>
   

3. Install the dependencies:

   yarn install
   

4. Create a .env file in the root directory and fill in the necessary environment variables:

   APP_URL=localhost:3000
   SUPABASE_URL=<your_supabase_url>
   SUPABASE_KEY=<your_supabase_key>
   

5. Start the development server:

   yarn start
   

Usage

Once the development server is running, you can access the application in your web browser at http://localhost:3000.

Contributing

If you would like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -m 'Add some feature').
5. Push to the branch (git push origin feature-branch).
6. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.