{"id":22930984,"url":"https://github.com/wardellbagby/lyricistant","last_synced_at":"2025-07-17T10:38:30.286Z","repository":{"id":37016799,"uuid":"170810100","full_name":"wardellbagby/lyricistant","owner":"wardellbagby","description":"A helpful writing assistant for lyricists!","archived":false,"fork":false,"pushed_at":"2025-07-01T02:51:18.000Z","size":67698,"stargazers_count":68,"open_issues_count":8,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-15T13:38:46.422Z","etag":null,"topics":["android","electron","electron-app","ios","lyrics","poetry","rhymes","typescript"],"latest_commit_sha":null,"homepage":"https://lyricistant.app","language":"TypeScript","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/wardellbagby.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null}},"created_at":"2019-02-15T06:01:41.000Z","updated_at":"2025-05-30T12:24:33.000Z","dependencies_parsed_at":"2024-01-13T22:48:01.283Z","dependency_job_id":"d0d7ca46-2fea-4bff-8136-3ceb5ce2805e","html_url":"https://github.com/wardellbagby/lyricistant","commit_stats":null,"previous_names":[],"tags_count":103,"template":false,"template_full_name":null,"purl":"pkg:github/wardellbagby/lyricistant","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wardellbagby%2Flyricistant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wardellbagby%2Flyricistant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wardellbagby%2Flyricistant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wardellbagby%2Flyricistant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wardellbagby","download_url":"https://codeload.github.com/wardellbagby/lyricistant/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wardellbagby%2Flyricistant/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265596132,"owners_count":23794843,"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":["android","electron","electron-app","ios","lyrics","poetry","rhymes","typescript"],"created_at":"2024-12-14T10:33:04.769Z","updated_at":"2025-07-17T10:38:30.258Z","avatar_url":"https://github.com/wardellbagby.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![lyricistant_logo](apps/mobile/android/app/src/main/res/mipmap-hdpi/ic_launcher_foreground.png)\n# Lyricistant\n\n![lyricistant](lyricistant.png)\n\nAn assistant to the lyricist in you!\n\n[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/wardellbagby/lyricistant?style=for-the-badge)](https://lyricistant.app/#download)\n[![GitHub Release Date](https://img.shields.io/github/release-date/wardellbagby/lyricistant?style=for-the-badge)](https://lyricistant.app/#download)\n[![GitHub](https://img.shields.io/github/license/wardellbagby/lyricistant?style=for-the-badge)](https://github.com/wardellbagby/lyricistant/blob/main/LICENSE.md)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/wardellbagby/lyricistant/Continuous-Integration.yml?branch=main\u0026style=for-the-badge)](https://github.com/wardellbagby/lyricistant/actions/workflows/Continuous-Integration.yml)\n\n## What is it?\n\nLyricistant is a writing app geared toward helping you write lyrics, poetry, or anything else you desire!\n\nUnlike other apps with a focus on rhyming, Lyricistant is first and foremost a writing app. It's made for you to use to\nwrite your lyrics, while offering helpful features to keep you in the writing zone.\n\nIts features include:\n\n- Showing the amount of syllables per line.\n- Contextually displaying rhymes as you type or select words.\n- Allowing easy lookups of definitions for words, with support for synonyms and antonyms.\n- Easily saving and reopening lyrics that you've made.\n- Showing you the history of your file.\n- _[Desktop and Web]_ Drag and Drop support for quickly reopening lyrics.\n- _[Desktop only]_ Remembering your recently opened lyrics to help you continue where you left off.\n- Both a light and dark theme that it can automatically switch between.\n- Automatically updating!\n- _[Android 12+ only]_ Matching your device's theme colors to effortlessly match Material You.\n- Available on your favorite platforms!\n  - [Mac](https://lyricistant.app/#download)\n  - [Windows](https://lyricistant.app/#download)\n  - [Linux](https://lyricistant.app/#download)\n  - [Web](https://lyricistant.app)\n  - [Android](https://play.google.com/store/apps/details?id=com.wardellbagby.lyricistant)\n  - [iOS](https://apps.apple.com/om/app/lyricistant/id1561506174)\n\n## How can I use it?\n\n#### [Browse it in your browser!](https://lyricistant.app)\n\n#### [Check it out on your computer!](https://lyricistant.app/#download)\n\n#### [Install it on your iPhone or iPad!](https://apps.apple.com/om/app/lyricistant/id1561506174)\n\n#### [Activate it on your Android device!](https://play.google.com/store/apps/details?id=com.wardellbagby.lyricistant)\n\n## What's up with the name?\n\nIt's a combination of two words:\n\n- Lyricist\n- Assistant\n\nLyricistant!\n\n## Information for developers\n\n### Documentation\n\nIt's a little outdated, but\nhere's [a blog post](https://dev.to/wardellbagby/the-architecture-of-an-electron-app-ported-to-web-399e) giving a\nhigh-level overview of Lyricistant.\n\nThe most up-to-date [documentation is here](docs/1-getting_started.md)\n\n### Building Lyricistant\n\nThis project uses [Gulp](https://gulpjs.com/) to build.\n\nThe easiest way to use Gulp is via installing Gulp globally via `npm install -g gulp`, but this isn't required as `Gulp`\nis included as a dev dependency for this project, and so doing `npm install; node_modules/.bin/gulp \u003ctask\u003e` will also\nwork.\n\nHow to check out and run the project:\n\n```shell\ngit checkout https://github.com/wardellbagby/lyricistant.git\ncd lyricistant\n# Starts the Electron app for development.\ngulp startElectron\n# Starts the Web app for development.\ngulp startWeb\n# Starts the Android app for development.\ngulp startAndroid\n# Starts the iOS app for development.\ngulp startIOS\n```\n\nIf you use a Jetbrains IDE (WebStorm, IntelliJ IDEA, etc) or Visual Studio Code, you can build and attach a debugger for\nall of these tasks natively in the IDE (via either Run Configurations for Jetbrains products or Run \u0026 Debug for Visual\nStudio Code).\n\n### Viewing the latest on `main`\n\nNew commits to `main` are automatically deployed, both on the web and as native binaries.\n\n- [Web](https://dev.lyricistant.app)\n- [Native binaries](https://github.com/wardellbagby/lyricistant/releases/tag/latest)\n\n### Running Tests\n\nThere are currently unit and UI tests in the project.\n\nYou can run all tests in a terminal via:\n\n```shell\ngulp testAll\n# To allow attaching a debugger\nnode --inspect-brk ./node_modules/.bin/gulp testAll\n```\n\nThere are various other test tasks that are named after the folder the tests are contained in. You can print a list of\nall test tasks by running:\n\n```\ngulp --tasks-simple | grep \"test\"\n```\n\nIf you're using VS Code or a Jetbrains IDE, you can also see the test tasks in your Run/Debug or Run Configurations,\nrespectively.\n\nYou can also run tests natively in your IDE using Jest, which will make it even easier to attach a debugger, as your IDE\nwill do that for you.\n\nIt's preferred to use the various `gulp` tasks to invoke tests, as they will handle any necessary prerequisites,\nsuch as building the app before running the tests. However, feel free to use Jest on the command line or in your IDE for\nbetter iteration, but make sure to also run the test via Gulp to verify that it works correctly!\n\n#### UI Tests\n\nWhen running the UI tests (`gulp testWeb` and `gulp testElectron`), you can set the environment variable `PWDEBUG` to\n`1` in order to open the Playwright Debugger and run the tests visibly.\n\nE.g.,\n\n```shell\nPWDEBUG=1 gulp testWeb\n```\n\nThis also works with Jest:\n\n```shell\nPWDEBUG=1 jest --projects apps/web/test\n```\n\n### Updating dependencies\n\nThere's a helper script at `scripts/install-latest.ts` that can be used to update all dependencies in the project that\nstart with a specific string to a specified version.\n\nThis is very useful for updating any scoped NPM dependencies that should be updated in lockstep (i.e., `@codemirror`).\n\nExample usage:\n\n```shell\n./scripts/install-latest.ts @codemirror 0.19.0 # omit to update to latest\n```\n\n### Committing\n\nThis project uses [Commitzen](https://github.com/commitizen/cz-cli) and [Commitlint](https://commitlint.js.org/#/) to\nenforce a single commit style.\n\nTo create a commit using an interactive wizard that follows the commit standards, run `git cz`\n\n## Code of Conduct\n\nWe aim to be an inclusive and welcoming community. To make that explicit, we have\na [code of conduct](CODE_OF_CONDUCT.md) that applies to this project.\n\n## License\n\nThis project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE.md) file for details\n\n[![forthebadge](https://forthebadge.com/images/badges/built-with-grammas-recipe.svg)](https://forthebadge.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwardellbagby%2Flyricistant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwardellbagby%2Flyricistant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwardellbagby%2Flyricistant/lists"}