{"id":22128552,"url":"https://github.com/rangerdigital/takagi","last_synced_at":"2026-04-11T05:32:16.182Z","repository":{"id":39180493,"uuid":"250372938","full_name":"RangerDigital/takagi","owner":"RangerDigital","description":"🍓 Service for creating instant and anonymous polls for free!","archived":false,"fork":false,"pushed_at":"2023-01-06T02:45:36.000Z","size":3101,"stargazers_count":3,"open_issues_count":43,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-29T14:16:13.636Z","etag":null,"topics":["cypress","docker","flask","mongodb","polls","pytest","python3","redis","sentry","vuejs2"],"latest_commit_sha":null,"homepage":"https://takagi.bednarski.dev","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RangerDigital.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-26T21:12:51.000Z","updated_at":"2022-02-28T06:26:59.000Z","dependencies_parsed_at":"2023-02-05T03:46:28.477Z","dependency_job_id":null,"html_url":"https://github.com/RangerDigital/takagi","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/RangerDigital%2Ftakagi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RangerDigital%2Ftakagi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RangerDigital%2Ftakagi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RangerDigital%2Ftakagi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RangerDigital","download_url":"https://codeload.github.com/RangerDigital/takagi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245240291,"owners_count":20583099,"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":["cypress","docker","flask","mongodb","polls","pytest","python3","redis","sentry","vuejs2"],"created_at":"2024-12-01T17:45:46.486Z","updated_at":"2025-12-30T20:34:55.732Z","avatar_url":"https://github.com/RangerDigital.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cbr /\u003e\u003cimg\n    width=\"600\"\n    src=\"logo.png\"\n    alt=\"Takagi - Online Polls\"\n  /\u003e\n\u003c/p\u003e\n\n---\n\n![Deploy - Frontend](https://github.com/RangerDigital/takagi/workflows/Deploy%20-%20Frontend/badge.svg?branch=master)\n![Build - Production](https://github.com/RangerDigital/takagi/workflows/Build%20-%20Production/badge.svg?branch=master)\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n\nSource code of **Takagi**, a simple web application build with **Flask** and **Vue.js** used to conduct quick and anonymous polls over the internet.\n\n\u003e 🔥 Takagi was built as an assignment for my university Web-Dev course.\n\nTakagi may lack certain business features because everything was done by me, that includes,  \ndesign, architecture, backend, frontend, testing and a lot of DevOps-y stuff in a limited amount of time.\n\n\u003e 👑 It's alive! Check it out live at [takagi.bednarski.dev](https://takagi.bednarski.dev/)!\n\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"render.png\" alt=\"Takagi - Mobile Mockup\" width=800/\u003e\n\u003c/p\u003e\n\n## 🛠 Best Features\n\n**Takagi is CDD (CV Driven Development) in the nutshell!**\n\nBelow are the features I had the most fun developing.\n\n- Simplified **JWT based authentication system** for users saving their polls.\n\n- Managed **Sentry** used for application monitoring and exception tracking.\n\n- **CI/CD** pipelines for automatic building and deploying on my infrastructure build on top of **GitHub Actions**.\n\n- Simple **End-To-End tests** build with the **Cypress** testing framework run before each frontend deploy by CI/CD system to achieve the best user experience.\n\n\u003cbr\u003e\n\n### Backend Specific\n\n- **Functional tests** for the API service build with **PyTest** and **Requests** modules.\n\n- Python 3 (Flask) **RESTful** API build on top of **MongoDB** for storing application state.\n\n- **Redis** based, cluster ready, **application-level rate limiting** on some of the API service endpoints.\n\n- Monitoring `/api/health` endpoint with the most valuable **performance counters** from **Redis**,\n  hooked up to my **Telegraf**, **InfluxDB** and **Grafana** metric monitoring infrastructure (_Cool graphs!_ 🤓)\n\n- Fully **Dockerized** development workflow, taking advantage of **docker-compose** for developing, testing and deployments.\n\n\u003cbr\u003e\n\n### Frontend Specific\n\n- Beautifully designed **SPA** frontend build with **Vue.js** and **Vue-Router**.\n\n- **Valve's Fingerprint.js 2** library used for identifying users to avoid duplicated votes.\n\n- **Client-side forms validation** build with **Vee-Validate** used for achieving better user experience.\n\n\u003cbr\u003e\n\nThat's all I can remember... 😉\n\n\u003cbr\u003e\n\n## 💻 Running Locally\n\n**It's easy to get started with developing Takagi!**\n\nThis project uses **Docker** as a development and production deployment tool, so **you need It** first!\n\n\u003cbr\u003e\n\n### Backend\n\n\u003e 💡 Execute every command in the `./backend` directory!\n\n**If you only want to run It**, you need to:\n\n- Spin up the whole stack as containers, simply type:\n\n  ```bash\n  docker-compose up -d\n  ```\n\nThis will spin up all the necessary containers and expose Takagi service **API** at `http://127.0.0.1:5000`.\n\n\u003cbr\u003e\n\n**If you want to make changes** to the **Flask** app, you need to:\n\n- Install **Python 3.8**, then projects requirements.\n\n  ```bash\n  pip3 install -r requirements.txt\n  ```\n\n- Also, It's _optionally_ development requirements.\n\n  ```bash\n  pip3 install -r dev-requirements.txt\n  ```\n\n- After that spin up **Redis** and **MongoDB** as containers.\n\n  ```bash\n  docker-compose up -d redis mongo\n  ```\n\n- Run `main.py`, entry point for Flask app.\n\n  ```bash\n  python3 ./main.py\n  ```\n\n  This will spin up databases, and run Python code with the development server at `http://127.0.0.1:5000`.\n\n\u003cbr\u003e\n\n### Frontend\n\n\u003e 💡 Execute every command in the `./frontend` directory!\n\nIf **you want to make changes** to the **Vue.js** app, you need to:\n\n- Install **NPM**, then projects requirements.\n\n  ```bash\n  npm install\n  ```\n\n- To then serve a website, simply type:\n\n  ```bash\n  npm run serve\n  ```\n\nThis will create a development web server at `http://127.0.0.1:8080`.\nAnd It's a lot simpler!\n\n\u003cbr\u003e\n\n## 📋 Running Tests\n\n**Takagi has a simple set of functional tests!**\n\nThis project uses **PyTest**, **PyLint** and **Cypress** as a testing tools, so **you need them** first!\n\n- To run **backend tests**, run Takagi API service and in the `./backend` directory type:\n\n  ```bash\n  pytest .\n  ```\n\n- To run **backend lint**, run in the `./backend` directory:\n\n  ```bash\n  pylint ../backend\n  ```\n\n- To run **Cypress E2E** tests, with everything running, open dashboard by typing:\n\n  ```bash\n  npm run open\n  ```\n\n  This will open a dashboard that will let you run all the specs.\n\n\u003cbr\u003e\n\n## 🚧 Contributing\n\n**You are more than welcome to help me improve Takagi!**\n\nJust fork this project from the `master` branch and submit a Pull Request (PR).  \nIt's probably a good idea to run all the tests beforehand.\n\n\u003cbr\u003e\n\n## 📃 License\n\nThis project is licensed under [GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/) .\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frangerdigital%2Ftakagi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frangerdigital%2Ftakagi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frangerdigital%2Ftakagi/lists"}