ClyoCloud

ClyoCloud is a modern, open-source file sharing platform built with Nuxt.js and Tailwind CSS. It provides a simple and intuitive interface for uploading, managing, and sharing files.

Technologies Used

• Core Framework: Nuxt 3
• Backend Engine: Nitro (Nuxt's built-in server)
• UI: Tailwind CSS with the DaisyUI component library
• Icons: Nuxt Icon
• Authentication: jsonwebtoken & bcryptjs
• File Handling: formidable for uploads
• Language: TypeScript
• Styling: Sass

Getting Started

Follow these steps to set up and run the project locally.

Prerequisites

• Node.js (LTS version recommended)
• npm (Node Package Manager) or Yarn

Installation

1. Clone the repository:

   git clone https://code.weexnes.dev/clyocloud
   cd clyocloud
   

2. Install dependencies:

   npm install
   

   or

   yarn install
   

Configuration

Create a .env file in the root directory of the project and add the following environment variables:

STORAGE_PATH=/path/to/your/storage
THUMBNAIL_PATH=/path/to/your/thumbnails

Note: The maxFileSize is set in nuxt.config.ts and is currently configured to 500MB.

Running the Development Server

npm run dev

or

yarn dev

This will start the development server at http://localhost:3000.

Building for Production

To build the application for production:

npm run build

or

yarn build

To preview the production build locally:

npm run preview

or

yarn preview

Project Structure

.
├── app.vue                 # Main Vue application entry
├── nuxt.config.ts          # Nuxt.js configuration
├── package.json            # Project dependencies and scripts
├── tailwind.config.js      # Tailwind CSS configuration
├── components/             # Vue components
├── core/                   # Core utilities and global configurations
├── middleware/             # Nuxt middleware
├── pages/                  # Vue pages/routes
├── public/                 # Static assets
├── server/                 # Backend API routes, models, and plugins
│   ├── api/                # API endpoints
│   ├── models/             # Data models
│   ├── plugins/            # Server-side plugins
│   └── routes/             # Server-side routes
└── types/                  # TypeScript types

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue.

License

This project is licensed under the MIT License.