{"id":16865895,"url":"https://github.com/danielbarion/instruct-contacts","last_synced_at":"2025-09-10T23:36:10.301Z","repository":{"id":47394900,"uuid":"203184051","full_name":"danielbarion/instruct-contacts","owner":"danielbarion","description":"A little application developed with Web Components using Lit-Element, Rollup, Stylus and a little bit of material design concept.","archived":false,"fork":false,"pushed_at":"2022-12-04T08:25:27.000Z","size":830,"stargazers_count":5,"open_issues_count":9,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T06:41:43.112Z","etag":null,"topics":["browserify","concept","jasmine","lit-element","rollup","stylus","webcomponents","yarn"],"latest_commit_sha":null,"homepage":"https://friendly-bose-005e60.netlify.com/","language":"JavaScript","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/danielbarion.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":"2019-08-19T14:00:09.000Z","updated_at":"2022-05-03T20:06:13.000Z","dependencies_parsed_at":"2023-01-22T23:16:26.668Z","dependency_job_id":null,"html_url":"https://github.com/danielbarion/instruct-contacts","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/danielbarion%2Finstruct-contacts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbarion%2Finstruct-contacts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbarion%2Finstruct-contacts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbarion%2Finstruct-contacts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danielbarion","download_url":"https://codeload.github.com/danielbarion/instruct-contacts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248370618,"owners_count":21092847,"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":["browserify","concept","jasmine","lit-element","rollup","stylus","webcomponents","yarn"],"created_at":"2024-10-13T14:48:46.386Z","updated_at":"2025-04-11T09:50:37.023Z","avatar_url":"https://github.com/danielbarion.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Instruct Contact App](https://i.imgur.com/QLcwFP8.png)\r\n\r\n## Instruct Contacts APP\r\nDemo: [https://friendly-bose-005e60.netlify.com/](https://friendly-bose-005e60.netlify.com/)\r\n\r\nRecommended OS: `Linux`, `OS X`.\r\nYou can test this app in `Windows` but you maybe need install `linux sub system` or use `git bash` to improve compatility and execute scripts.\r\n\r\n### Informations\r\nThis project use [web components](https://developer.mozilla.org/pt-BR/docs/Web/Web_Components) concept to have a high performance like native elements.\r\nAll components are build with `HTML`, `CSS` (Stylus), `Javascript`.\r\n\r\nBehind the scenes we have a open source project [Lit-Element](https://lit-element.polymer-project.org/) that I'm contributing to the documentation.\r\n\r\n* Components\r\n\u003e All components has a `wc` prefix\r\n\r\n* Modules\r\n\u003e All modules has a `instruct` prefix\r\n\r\n\r\n### Available Scripts\r\nBefore anything you need install all dependencies:\r\n\r\n- Yarn\r\n```bash\r\nyarn\r\n```\r\n- npm\r\n```bash\r\nnpm install\r\n```\r\n\r\n#### Development\r\n```bash\r\nyarn start\r\n```\r\nThis command will run development steps into source code and serve with Browserify.\r\n\r\n#### Development\r\n```bash\r\nyarn start-stand-alone\r\n```\r\nIf you prefer serve the app more static, you can use this command and use [serve](https://www.npmjs.com/package/serve) to access the app.\r\nThis command will run development steps into source code and will not run browserify.\r\n\r\n- NPM\r\n```bash\r\nnpm i -g serve\r\n```\r\n\r\n- Yarn\r\n```bash\r\nyarn global add serve\r\n```\r\n\r\nOnce that's done, you can run this command inside your project's directory:\r\n\r\n```bash\r\nserve build -l 3005\r\n```\r\n\r\nWhere `build` is the `folder` and `3005` is the `port`.\r\n\r\n#### Production\r\n```bash\r\nyarn build\r\n```\r\nThis command will run production steps (minify, uglify and no source map) and will not serve the app.\r\nTo test you can serve the app as your want in your server or use `serve` like the stand alone flow.\r\n\r\n#### Tests\r\nFirst, add `Jasmine` to your enviroment, I strongly recommend add jasmine global:\r\n\r\n```bash\r\nnpm i -g jasmine\r\n```\r\n\r\nNow you just need run the command below:\r\n\r\n```\r\nyarn test\r\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielbarion%2Finstruct-contacts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielbarion%2Finstruct-contacts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielbarion%2Finstruct-contacts/lists"}