{"id":26129663,"url":"https://github.com/piopi/project-kf","last_synced_at":"2026-04-21T11:06:59.076Z","repository":{"id":46197120,"uuid":"423523388","full_name":"piopi/project-KF","owner":"piopi","description":"Full-Stack Klipfolio project ","archived":false,"fork":false,"pushed_at":"2021-11-08T03:38:05.000Z","size":1258,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-10T05:19:55.612Z","etag":null,"topics":["full-stack","fullstack-development","klipfolio"],"latest_commit_sha":null,"homepage":"https://assessment-klipfolio.herokuapp.com/","language":"TypeScript","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/piopi.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}},"created_at":"2021-11-01T15:47:32.000Z","updated_at":"2021-11-16T18:29:46.000Z","dependencies_parsed_at":"2022-09-25T06:10:43.516Z","dependency_job_id":null,"html_url":"https://github.com/piopi/project-KF","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piopi%2Fproject-KF","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piopi%2Fproject-KF/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piopi%2Fproject-KF/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piopi%2Fproject-KF/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/piopi","download_url":"https://codeload.github.com/piopi/project-KF/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242918573,"owners_count":20206518,"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":["full-stack","fullstack-development","klipfolio"],"created_at":"2025-03-10T19:57:18.086Z","updated_at":"2026-04-21T11:06:59.012Z","avatar_url":"https://github.com/piopi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Klipfolio Project Assessment  [![CI/CD pipeline](https://github.com/piopi/project-KF/actions/workflows/push.yml/badge.svg?branch=main)](https://github.com/piopi/project-KF/actions/workflows/push.yml) [![Deploy](https://github.com/piopi/project-KF/actions/workflows/deploy.yml/badge.svg)](https://github.com/piopi/project-KF/actions/workflows/deploy.yml)\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#overview\"\u003eOverview\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#screenshots\"\u003eScreenshots\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#features\"\u003eFeatures\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#cicd\"\u003eCI/CD Pipeline with Github Actions\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#api\"\u003eAPI Endpoints\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## Overview\nThis is a project assessment of my full stack skills for Klipfolio. In this project, I implemented all the requirements of the mock design and some additional functionalities on the backend and frontend of the application. (See [Features Section](#features))\n### Screenshots\n**Normal mode:**\n![Normal Mode](/assets/Klipfolio-Assessment.png)\n**Dark mode**\n![Dark Mode](/assets/Klipfolio-Assessment-Dark.png)\n**Search function**\n![Search function](/assets/SearchFunction.png)\n\n\n### Built With\n\n* [React.js](https://reactjs.org/)\n* [Typescript](https://www.typescriptlang.org/)\n* [Chakra-UI](https://chakra-ui.com/)\n* [Redux](https://redux.js.org/)\n* [NodeJS](https://nodejs.org/en/)\n* [Express](https://expressjs.com/)\n* [PostgreSQL](https://www.postgresql.org/)\n* [Docker](https://www.docker.com/)\n\n**Deployed on Heroku**\n\n## Getting Started\n\nYou can either run the app locally or head over (for a live version) : \nhttps://assessment-klipfolio.herokuapp.com/\n#### Running Application Locally\n\n##### Requirement:\n- [Docker](https://docs.docker.com/get-docker/)\n\nAt the root of the folder, run the following command:\n```\ndocker-compose up -d\n```\nYou access the react app at: `http://localhost:3000`\nAnd the server at: `http://localhost:3001`\n\n## Features\n\n- Fully Responsive Application\n- Dark mode\n- RestAPI that fetches from the Database (PostgreSQL)\n- Search and filter functionalities\n- Data represented in graphs using ChartJS\n- Containerized application for quick development and deployment\n- CI/CD Pipeline for linting and testing \n- Auto-deployement to Heroku with GitHub Actions\n\n\u003ca id=\"cicd\" \u003e \u003c/a\u003e\n## CI/CD Pipeline with Github Actions\n\nWhen a pull request is made:\nStages:\n1. Build Images\n2. Lint Server \u0026 Client\n3. Test Server \u0026 Client (Integration \u0026 Unit tests)\n\nWhen a push is made on the main branch:\n- Build Docker image and auto Deploy to Heroku\n\n\u003ca id=\"api\" \u003e \u003c/a\u003e\n## API Endpoints\n* **Get all services** : `GET /api/services/`\n\n  ```\n   Example of output:\n  [\n    {\n    \"serviceId\": 1,\n    \"name\": \"Facebook\",\n    \"serviceIconUrl\": \"url\",\n    \"createdAt\": \"2021-11-08T00:39:13.647Z\",\n    \"updatedAt\": \"2021-11-08T00:39:13.647Z\"\n    }\n  ]\n  ```\n* **Get all data sources of a service** : `GET /api/datasources?serviceId=:id`\n  ```\n   Example of output:\n   [\n    {\n    \"dataId\": 1,\n    \"dataName\": \"Ad Revenue\",\n    \"dataCurrency\": \"$\",\n    \"createdAt\": \"2021-11-08T00:39:13.677Z\",\n    \"updatedAt\": \"2021-11-08T00:39:13.677Z\",\n    \"serviceId\": 1,\n    \"ServiceServiceId\": null\n    }\n  ]\n  ```\n* **Get all data entries of a data source** : `GET /api/dataentries?dataId=:id\u0026limit=:number`\n```\n   Example of output:\n   {\n    \"data\": [\n    471.17,\n    238.78,\n    313.21,\n    341.55,\n    252.24,\n    324.72,\n    303.16,\n    413.09,\n    384.74,\n    279.82\n    ],\n    \"dataEntryName\": \"Ad Profit\",\n    \"dataCurrency\": \"$\"\n    }\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiopi%2Fproject-kf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpiopi%2Fproject-kf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiopi%2Fproject-kf/lists"}