{"id":27369949,"url":"https://github.com/davicho-dev/tinkin-code-challenge-front","last_synced_at":"2026-04-06T09:32:08.778Z","repository":{"id":287156932,"uuid":"958302135","full_name":"Davicho-Dev/Tinkin-Code-Challenge-Front","owner":"Davicho-Dev","description":"Tinkin Code Challenge","archived":false,"fork":false,"pushed_at":"2025-04-09T04:21:37.000Z","size":69787,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T08:12:36.783Z","etag":null,"topics":["atomic-design","axios","cypress","eslint","gsap","gsap-animation","husky","jest","prettier","react","react-icons","react-redux","react-tooltip","redux-toolkit","rtk-query","sass","tailwindcss","typescript","uuid","vite"],"latest_commit_sha":null,"homepage":"https://tinkin.davicho.dev","language":"TypeScript","has_issues":false,"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/Davicho-Dev.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":"2025-04-01T01:17:21.000Z","updated_at":"2025-04-09T14:51:28.000Z","dependencies_parsed_at":"2025-04-10T09:13:58.754Z","dependency_job_id":"23f0a94b-fcfd-4bf0-b3a5-5b0b999f4bfb","html_url":"https://github.com/Davicho-Dev/Tinkin-Code-Challenge-Front","commit_stats":null,"previous_names":["davicho-dev/tinkin-code-challenge-front"],"tags_count":0,"template":false,"template_full_name":"Davicho-Dev/ReactTs-Vite-Jest-Testing_Library-TailwindCSS-Cypress-Storybook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Davicho-Dev%2FTinkin-Code-Challenge-Front","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Davicho-Dev%2FTinkin-Code-Challenge-Front/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Davicho-Dev%2FTinkin-Code-Challenge-Front/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Davicho-Dev%2FTinkin-Code-Challenge-Front/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Davicho-Dev","download_url":"https://codeload.github.com/Davicho-Dev/Tinkin-Code-Challenge-Front/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248681496,"owners_count":21144700,"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":["atomic-design","axios","cypress","eslint","gsap","gsap-animation","husky","jest","prettier","react","react-icons","react-redux","react-tooltip","redux-toolkit","rtk-query","sass","tailwindcss","typescript","uuid","vite"],"created_at":"2025-04-13T08:12:43.746Z","updated_at":"2025-12-30T20:00:56.364Z","avatar_url":"https://github.com/Davicho-Dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tinkin - Code Challenge\n\n## Installation and Running the Project\n\n### Prerequisites\n\nEnsure you have the following installed on your machine:\n\n1. **Bun**: A fast JavaScript package manager. To install `bun`, run (macOS/Linux):\n\n```bash\n   curl -fsSL https://bun.sh/install | bash\n```\n\n1. Recommended Node.js version: **v18.x or above** (only required as necessary for Bun compatibility).\n\n### Steps to Install and Run the Project\n\n1. **Clone the Repository**:\n\n```bash\n   git clone git@github.com:Davicho-Dev/Tinkin-Code-Challenge.git\n   cd Tinkin-Code-Challenge\n```\n\n1. **Install Dependencies** with Bun:\n\n```bash\n   bun install\n```\n\nThis command will install all required dependencies based on the `package.json`.\n\n1. **Run the Development Server**:\n\n```bash\n   bun run dev\n```\n\nThe development server will start. You can access the application locally at:\n\n```\n   http://localhost:3000\n```\n\n## Deployment in the Cloud\n\nThe project has been deployed on **tinkin.davicho.dev**.\nTo view the application in production:\n\n1. Open a browser and navigate to:\n\n```\n   https://tinkin.davicho.dev\n```\n\n1. Log in using the credentials provided to you via email:\n   - **Username**: DavichoDev.\n   - **Password**: Provided in the email.\n\n## Libraries and Tools Used\n\n### Core Libraries\n\n- **React** (v19.0.0): A library for building user interfaces.\n- **React DOM** (v19.0.0): For rendering React components.\n- **TypeScript** (v5.7.2): Provides static typing for JavaScript.\n- **Redux Toolkit** (v2.6.1): Simplified and efficient state management.\n\n### Development Tools\n\n- **Vite** (v6.2.0): Lightning-fast development server and build tool.\n- **ESLint** (v9.21.0): For linting JavaScript/TypeScript to enforce coding standards.\n- **Prettier** (v3.5.3): A formatter to ensure consistent code style.\n- **Husky** (v9.1.7) and **Lint-Staged** (v15.5.0): Git hooks to automate pre-commit tasks.\n\n### Styling\n\n- **TailwindCSS**: A utility-first CSS framework for rapid UI development.\n- **PostCSS** (v8.5.3) and **Autoprefixer** (v10.4.21): Tools for CSS processing and adding browser compatibility.\n- **Sass** (v1.86.1): CSS preprocessor for extended styling options.\n\n### Testing\n\n- **Jest** (v29.7.0): Extensive framework for unit and integration testing.\n- **Cypress** (v14.2.1): Provides functional and end-to-end (E2E) testing.\n\n### Additional Libraries\n\n- **Axios** (v1.8.4): To handle HTTP requests conveniently.\n- **UUID** (v11.1.0): For generating unique identifiers.\n- **React Router DOM** (v7.4.1): For handling routing in the application.\n- **React Tooltip** (v5.28.0): For adding customizable tooltips.\n- **React Hot Toast** (v2.5.2): Lightweight toast notifications.\n- **GSAP** (v3.12.7) and **@gsap/react** (v2.1.2): Rich animation library for user interface elements.\n\n## Testing the Project\n\n### Unit Testing with Jest\n\nRun the Jest test suite for unit tests:\n\n```bash\nbun unit\n```\n\n### End-to-End (E2E) Testing with Cypress\n\nTo run Cypress and perform E2E tests:\n\n```bash\nbun e2e\n```\n\nTests are preconfigured to ensure they're compatible with the application.\n\n## Code Quality: Linting \u0026 Formatting\n\n### Check for Linting Errors\n\nTo check for coding style issues using **ESLint**:\n\n```bash\nbun lint\n```\n\n**Husky** and **Lint-Staged** will automatically run these checks before committing code to ensure quality.\n\n## Notes\n\n- Always keep your `.env` file updated with the necessary local and production keys.\n- After installing any new dependencies, be sure to re-run:\n\n```bash\n  bun install\n```\n\n- For production builds, ensure you're using optimized configurations (e.g., `.env.production`).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavicho-dev%2Ftinkin-code-challenge-front","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavicho-dev%2Ftinkin-code-challenge-front","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavicho-dev%2Ftinkin-code-challenge-front/lists"}