{"id":27941108,"url":"https://github.com/itmysm/arvan-challenge","last_synced_at":"2026-01-21T08:35:23.427Z","repository":{"id":260118736,"uuid":"879608511","full_name":"itmysm/arvan-challenge","owner":"itmysm","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-29T14:05:16.000Z","size":65,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-29T17:13:34.696Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itmysm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-28T08:25:11.000Z","updated_at":"2024-10-29T14:05:20.000Z","dependencies_parsed_at":"2024-10-29T17:37:27.461Z","dependency_job_id":null,"html_url":"https://github.com/itmysm/arvan-challenge","commit_stats":null,"previous_names":["itmysm/arvan-challenge"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itmysm%2Farvan-challenge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itmysm%2Farvan-challenge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itmysm%2Farvan-challenge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itmysm%2Farvan-challenge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itmysm","download_url":"https://codeload.github.com/itmysm/arvan-challenge/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252860835,"owners_count":21815584,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-07T10:37:43.406Z","updated_at":"2026-01-21T08:35:23.399Z","avatar_url":"https://github.com/itmysm.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Arvan Cloud Dashboard Challenge\n\nThis project is a dashboard application developed for the Arvan Cloud technical challenge. It serves as a single-page dashboard with authentication, article management, and responsive components, created with **Vue 3**, **Pinia**, **Bootstrap**, and **Axios**. The backend is powered by **Xano** for data storage and API management, and the project is deployed on [Netlify](https://challenge-arvan.netlify.app).\n\n## Table of Contents\n\n- [Project Overview](#project-overview)\n- [Technologies](#technologies)\n- [Project Structure](#project-structure)\n- [Setup and Installation](#setup-and-installation)\n- [Scripts](#scripts)\n- [Key Features](#key-features)\n- [License](#license)\n\n## Project Overview\n\nThe Arvan Cloud Dashboard is designed to demonstrate essential features for a typical admin interface, including:\n- User authentication\n- Article management (create, edit, and view articles)\n- Dynamic components (alert, modal, and dropdown)\n- Responsive layout with a navigation sidebar\n\n## Technologies\n\nThe following libraries and tools were used to build this application:\n\n- **Vue 3**: The framework for building the application.\n- **Pinia**: State management for efficient and modular data handling.\n- **Bootstrap**: Used for styling and layout, with custom SCSS for unique designs.\n- **Axios**: For handling HTTP requests to Xano.\n- **Xano**: Backend-as-a-Service, providing REST APIs for data management.\n- **Vite**: A modern, fast build tool for bundling the project.\n- **Netlify**: For hosting and deploying the application.\n\n## Project Structure\n\nHere’s an overview of the main files and folders:\n\n```plaintext\nproject-root\n├── dist                     # Production-ready files after build\n├── public                   # Public assets, including favicons\n├── src                      # Main application code\n│   ├── assets               # Static assets and styles\n│   ├── components           # Reusable UI components\n│   │   ├── icons            # Icon components (e.g., close, menu)\n│   │   ├── pages            # Components organized by feature\n│   │   └── ui               # UI elements (Alert, Dropdown, Modal)\n│   ├── layouts              # Layout components (e.g., Dashboard layout)\n│   ├── middleware           # Middleware for route guards (e.g., auth)\n│   ├── pages                # Main application pages (login, register, dashboard)\n│   ├── router               # Vue Router configuration\n│   ├── stores               # Pinia stores for state management\n│   ├── utils                # Utility functions (e.g., date conversion)\n│   └── types                # TypeScript type definitions\n├── .editorconfig            # Editor configuration\n├── .env                     # Environment variables\n├── .gitignore               # Files to ignore in Git\n├── tsconfig.json            # TypeScript configuration\n├── vite.config.ts           # Vite configuration file\n└── package.json             # Project dependencies and scripts\n```\n\n## Setup and Installation\n\nTo set up the project locally, follow these steps:\n\n### Prerequisites\n\n- **Node.js** (version 16.x or later recommended)\n- **npm** (included with Node.js)\n\n### Installation Steps\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/itmysm/arvan-challenge.git\n   cd arvan-challenge\n   ```\n\n2. Install dependencies:\n\n   ```bash\n   npm install\n   ```\n\n3. Create a `.env` file in the project root and add any required environment variables, such as the Xano API URL or API keys.\n\n4. Start the development server:\n\n   ```bash\n   npm run dev\n   ```\n\n   The application will be available at `http://localhost:5173`.\n\n## Scripts\n\nHere are the main scripts for development and production:\n\n- **`dev`**: Runs the development server using Vite.\n- **`build`**: Builds the project for production, including type-checking.\n- **`preview`**: Launches a locally hosted version of the production build.\n- **`type-check`**: Type-checks the project using TypeScript.\n- **`lint`**: Lints and fixes issues in the code using ESLint.\n- **`format`**: Formats code in the `src/` folder using Prettier.\n\nFor example, to build the project for production:\n\n```bash\nnpm run build\n```\n\n## Key Features\n\n1. **Authentication**:\n   - Secure login and registration pages using Pinia for state management and middleware for route guards.\n\n2. **Dashboard Layout**:\n   - A responsive dashboard layout with a sidebar navigation for easy access to different sections.\n\n3. **Article Management**:\n   - A structured system for creating, editing, and viewing articles, with form components (`FormArticle.vue`) to handle input and validation.\n\n4. **Reusable UI Components**:\n   - Dynamic and reusable components like `Alert`, `Modal`, and `Dropdown`, ensuring a cohesive and interactive user experience.\n\n5. **Utilities**:\n   - Custom utility functions for tasks like date formatting and text shortening, enhancing readability and maintainability.\n\n## License\n\nThis project was created for the Arvan Cloud technical challenge and is for demonstration purposes only.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitmysm%2Farvan-challenge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitmysm%2Farvan-challenge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitmysm%2Farvan-challenge/lists"}