{"id":17056334,"url":"https://github.com/biophoton/ng-gulp-starter","last_synced_at":"2026-04-11T05:32:08.862Z","repository":{"id":77494354,"uuid":"53199926","full_name":"BioPhoton/ng-gulp-starter","owner":"BioPhoton","description":"Basic folder structure for an angular js project with a gulp setup seperated into files.","archived":false,"fork":false,"pushed_at":"2016-07-08T09:29:16.000Z","size":103,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-01-03T16:24:23.199Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/BioPhoton.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":"2016-03-05T12:17:26.000Z","updated_at":"2016-03-06T21:07:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"f06a4fd8-c10f-4893-aeb3-48e8025b3e6d","html_url":"https://github.com/BioPhoton/ng-gulp-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/BioPhoton/ng-gulp-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BioPhoton%2Fng-gulp-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BioPhoton%2Fng-gulp-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BioPhoton%2Fng-gulp-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BioPhoton%2Fng-gulp-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BioPhoton","download_url":"https://codeload.github.com/BioPhoton/ng-gulp-starter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BioPhoton%2Fng-gulp-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31669677,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T17:19:37.612Z","status":"online","status_checked_at":"2026-04-11T02:00:05.776Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2024-10-14T10:24:06.097Z","updated_at":"2026-04-11T05:32:08.840Z","avatar_url":"https://github.com/BioPhoton.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"#Setup\n\nfor general information visit the official\n[ionic guide](http://ionicframework.com/docs/guide/).\n\n\n##Setup environment \n\n- nodeJs\n\nThe pre-requisite for building or running the project is to have\n[node.JS](https://nodejs.org/en/download/) installed.\n \nIf you don't have the executable `npm` in your PATH you can check it with ```which npm``\nDownload and install the version for your OS.\n\n!!!NOTICE!!!\nVersions are not the same through OS.\n\nVersion 2 of `npm` is required; version 3 will not work on Linux. \n@TODO check versions for windows \n\nLinux/OS X downgrade:\n    sudo npm install -g npm@latest-2\n\n- ionic environment\n\nTo setup/re-setup the ionic development environment and all the project dependencies \nexecute the script `setup-environment.sh` or go through the steps manually. \n\nThe `setup-environment` script installs:\n  - ionic \n  - cordova \n  - bower \n  - tsd\n\nThe following command in a shell will install all three.   \nThe script `setup-environment.sh` also performs this task.     \n\n```bash\n$ sudo npm install -g ionic cordova bower typings\n```\n\n\n## Setup project for desktop development\n \n###Git\n\nCheck out the project\n  ```bash\n  $ git clone [repository] [project name]\n  ```\nCheck that the current user have write permissions to the newly created folder.\nThen cd into the folder and check out the master branch\n  ```bash\n  $ cd [project_name]\n  $ git checkout master\n  ```\n\n### Project\n0. cd into the [project_name] folder.\n```bash\n   cd [project_name]\n```\n\nTo setup/re-setup the project execute the script `reset-project.sh` or go through the steps manually.\n\nThe `reset-project.sh` script:\n  - cleans all auto-generated folders\n  - installs all dependencies for\n    - npm\n    - bower\n    - tsd\n  - compiles the initial codebase\n  - creates device depending resources (icons and splashscreen images)\n  - installs all supported platforms of this project\n  - installs all cordova plugins\n  \n  \n```bash\n./reset-project.bash\n```\n \n1. Setup node_modules folder\n\n  In the branch is a package.json file which\n  contains all required node modules required for the gulp tasks as\n  well as the platforms and plugins for cordova.\n   \n  When executing this command following folders will be generated:\n  - node_modules\n  \n```bash\nnpm install\n```\n\n2. Setup typings folder\n\n  In the branch is a tsd.json file which\n  contains all required type definitions required for the project.\n   \n  When executing this command following folders will be generated:\n  - typings\n  \n```bash\ntsd install\n```\n\n3. Load bower lib's\n\n   Third party libraries are installed via the `bower`.\n   \n   When executing this command following folders will be generated:\n   - www\n     - lib\n\n```bash\nbower update\n```\n\n4. init project (compile basic content for www folder)\n\n```bash\ngulp project:init\n```\n\n5. Subsequent manual compilations are done with\n\n```bash\ngulp project:compile\n```\n    \nor by using the ```project:watch``` task\n```bash\ngulp project:watch\n```\n      \n  5. 1. Environment specific compilations are done by setting then ```NODE_ENV``` var.\n     By default the environment is set to local\n  \n```bash\n$NODE_ENV='staging' gulp project:compile\n```\n\n\n###Setup custom environment variables\n\nThe project is shipped with a default environment setting.  \nThis can be overridden by creating the specific \nenvironments [env].config.json files in the config folder.\n\nTo setup/re-setup your personal config file execute the script `setup-evn-vars.sh` or go through the steps manually.\n\nThe `setup-evn-vars.sh` script:\n  - copies the base.config.json and renames it to the users input\n  - sets up a symlink to local.config.json\n  \n1. cd into the ```config``` folder\n\n```bash\n$ cd config\n```\n\n2. To create your custom ```local``` environment settings copy the\nshipped ```base.config.json```\n\n```bash\n$ cp base.config.json [YourStringHere].config.json\n```\n\n3. Now setup a symbolic link of this file named ```local.config.json```\n\n```bash\n$ ln -s [YourStringHere].config.js local.config.json\n```\n\n3. 1. You can also create just the ```local.config.json``` if you prefer to work without symlinks\n\n```bash\n$ cp base.config.json local.config.json\n```\n\n\n\n##Serve project locally\n\nYou can run the project (without native functionality) in the browser.\n```bash\n$ ionic serve\n```\n\nYou could implement templatecache and minified css by using following command.\n```bash\n$ gulp project:optimize\n```\n\n##Serve project in emulator\n@TODO write doc\n\n##Serve project on device\n\nTo build your project for platforms or debugging over console setup codrova platforms and plugins.\nThese are defined in the package.json file\n\n```bash\n$ ionic state restore\n$ ionic resources\n```\n\nThis will create the platforms folder and loads cordova android and ios platform.\nIt also creates the plugins folder and loads the plugins defined in package.json\n\nTo run the project on your mobile phone run following command\n\n```bash\n$ ionic run android -d -l -c\n```\n\n\n##View remote\n\nTo easily share project progress use [ionic view](http://view.ionic.io/).\nYou can view it over the ionic app_id located in ionic.project in the root folder.  \napp ID: *??????*","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbiophoton%2Fng-gulp-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbiophoton%2Fng-gulp-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbiophoton%2Fng-gulp-starter/lists"}