{"id":27337634,"url":"https://github.com/qntum-dev/kannect","last_synced_at":"2025-04-12T15:18:30.811Z","repository":{"id":286604942,"uuid":"961409969","full_name":"qntum-dev/kannect","owner":"qntum-dev","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-10T13:59:12.000Z","size":47,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T15:18:27.252Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/qntum-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-06T13:16:14.000Z","updated_at":"2025-04-10T13:59:16.000Z","dependencies_parsed_at":"2025-04-07T12:53:09.119Z","dependency_job_id":null,"html_url":"https://github.com/qntum-dev/kannect","commit_stats":null,"previous_names":["qntum-dev/kannect"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qntum-dev%2Fkannect","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qntum-dev%2Fkannect/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qntum-dev%2Fkannect/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qntum-dev%2Fkannect/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qntum-dev","download_url":"https://codeload.github.com/qntum-dev/kannect/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248586235,"owners_count":21128998,"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-04-12T15:18:29.765Z","updated_at":"2025-04-12T15:18:30.790Z","avatar_url":"https://github.com/qntum-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kannect\nThis is a chat application backend made with Encore TS.\n\n## Prerequisites \n\n**Install Encore:**\n- **macOS:** `brew install encoredev/tap/encore`\n- **Linux:** `curl -L https://encore.dev/install.sh | bash`\n- **Windows:** `iwr https://encore.dev/install.ps1 | iex`\n  \n**Docker:**\n1. [Install Docker](https://docker.com)\n2. Start Docker\n\n**Install npm dependencies:**\n1. npm i\n\n\u003c!-- ## Run app locally\nRun this command from your application's root folder:\n\n```bash\nencore run\n```\n\n## Using the API\n\n### url.shorten — Shortens a URL and adds it to the database\n\n```bash\ncurl 'http://127.0.0.1:4000/url' -d '{\"url\":\"https://google.com\"}'\n```\n\n### url.get — Gets a URL from the database using a short ID\n\n```bash\ncurl 'http://127.0.0.1:4000/url/:id'\n```\n\n### url.list — Lists all shortened URLs\n\n```bash\ncurl 'http://127.0.0.1:4000/url'\n```\n\n## Open the developer dashboard\n\nWhile `encore run` is running, open [http://localhost:9400](http://localhost:9400) to access Encore's [local developer dashboard](https://encore.dev/docs/ts/observability/dev-dash).\n\nHere you can see API docs, make requests in the API explorer, and view traces of the responses.\n\n## Using the API\n\nTo see that your app is running, you can ping the API to shorten a url.\n\n```bash\ncurl 'http://localhost:4000/url' -d '{\"url\":\"https://news.ycombinator.com\"}'\n```\n\nWhen you ping the API, you will see traces and logs appearing in the local development dashboard: [http://localhost:9400](http://localhost:9400)\n\n## Connecting to databases\n\nYou can connect to your databases via psql shell:\n\n```bash\nencore db shell \u003cdatabase-name\u003e --env=local --superuser\n```\n\nLearn more in the [CLI docs](https://encore.dev/docs/ts/cli/cli-reference#database-management).\n\n## Deployment\n\n### Self-hosting\n\nSee the [self-hosting instructions](https://encore.dev/docs/ts/self-host/build) for how to use `encore build docker` to create a Docker image and configure it.\n\n### Encore Cloud Platform\n\nDeploy your application to a free staging environment in Encore's development cloud using `git push encore`:\n\n```bash\ngit add -A .\ngit commit -m 'Commit message'\ngit push encore\n```\n\nYou can also open your app in the [Cloud Dashboard](https://app.encore.dev) to integrate with GitHub, or connect your AWS/GCP account, enabling Encore to automatically handle cloud deployments for you.\n\n## Link to GitHub\n\nFollow these steps to link your app to GitHub:\n\n1. Create a GitHub repo, commit and push the app.\n2. Open your app in the [Cloud Dashboard](https://app.encore.dev).\n3. Go to **Settings ➔ GitHub** and click on **Link app to GitHub** to link your app to GitHub and select the repo you just created.\n4. To configure Encore to automatically trigger deploys when you push to a specific branch name, go to the **Overview** page for your intended environment. Click on **Settings** and then in the section **Branch Push** configure the **Branch name** and hit **Save**.\n5. Commit and push a change to GitHub to trigger a deploy.\n\n[Learn more in the docs](https://encore.dev/docs/platform/integrations/github)\n\n## Testing\n\nTo run tests, configure the `test` command in your `package.json` to the test runner of your choice, and then use the command `encore test` from the CLI. The `encore test` command sets up all the necessary infrastructure in test mode before handing over to the test runner. [Learn more](https://encore.dev/docs/ts/develop/testing)\n\n```bash\nencore test\n``` --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqntum-dev%2Fkannect","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqntum-dev%2Fkannect","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqntum-dev%2Fkannect/lists"}