Skip to content

Instantly share code, notes, and snippets.

@jgw96
Created June 21, 2017 19:57
Show Gist options
  • Save jgw96/811d3486edbbbaebd1cee133ef59051b to your computer and use it in GitHub Desktop.
Save jgw96/811d3486edbbbaebd1cee133ef59051b to your computer and use it in GitHub Desktop.
conf app edited readme

Ionic Conference Application

This is purely a demo of Ionic with TypeScript. It is still in development.

Important!

There is not an actual Ionic Conference at this time. This project is just to show off Ionic components in a real-world application. Please go through the steps in CONTRIBUTING.md before submitting an issue.

Table of Contents

Getting Started

  • Clone this repository: git clone https://github.com/ionic-team/ionic-conference-app.git.
  • Want to use TypeScript? Both the master branch and the typescript branch now use TypeScript.
  • Run npm install from the project root.
  • Install the ionic CLI (npm install -g ionic)
  • Run ionic serve in a terminal from the project root.
  • Profit

Note: Is your build slow? Update npm to 3.x: npm install -g npm.

Contributing

See CONTRIBUTING.md πŸŽ‰πŸ‘

Use Cases

App Preview

Try it live

All app preview screenshots were taken by running ionic serve --lab on a retina display.

Deploying

  • PWA - Un-comment this, run npm run ionic:build --prod and then push the www folder to your favorite hosting service
  • Android - Run ionic cordova run android --prod
  • iOS - Run ionic cordova run ios --prod

File Structure of App

ionic-conference-app/
β”œ-- .github/                            * GitHub files
β”‚   β”œβ”€β”€ CONTRIBUTING.md                 * Documentation on contributing to this repo
β”‚   └── ISSUE_TEMPLATE.md               * Template used to populate issues in this repo
|
|-- resources/
|
|-- src/
|    |-- app/
|    |    β”œβ”€β”€ app.component.ts
|    |    └── app.module.ts
|    |    └── app.template.html
|    |    └── main.ts
|    |
|    |-- assets/
|    |    β”œβ”€β”€ data/
|    |    |    └── data.json
|    |    |
|    |    β”œβ”€β”€ fonts/
|    |    |     β”œβ”€β”€ ionicons.eot
|    |    |     └── ionicons.svg
|    |    |     └── ionicons.ttf
|    |    |     └── ionicons.woff
|    |    |     └── ionicons.woff2
|    |    |
|    |    β”œβ”€β”€ img/
|    |
|    |-- pages/                          * Contains all of our pages
β”‚    β”‚    β”œβ”€β”€ about/                     * About tab page
β”‚    β”‚    β”‚    β”œβ”€β”€ about.html            * AboutPage template
β”‚    β”‚    β”‚    └── about.ts              * AboutPage code
β”‚    β”‚    β”‚    └── about.scss            * AboutPage stylesheet
β”‚    β”‚    β”‚
β”‚    β”‚    β”œβ”€β”€ account/                   * Account page
β”‚    β”‚    β”‚    β”œβ”€β”€ account.html          * AccountPage template
β”‚    β”‚    β”‚    └── account.ts            * AccountPage code
β”‚    β”‚    β”‚    └── account.scss          * AccountPage stylesheet
β”‚    β”‚    β”‚
β”‚    β”‚    │── login/                     * Login page
β”‚    β”‚    β”‚    β”œβ”€β”€ login.html            * LoginPage template
β”‚    β”‚    β”‚    └── login.ts              * LoginPage code
β”‚    β”‚    β”‚    └── login.scss            * LoginPage stylesheet
β”‚    β”‚    β”‚
β”‚    β”‚    │── map/                       * Map tab page
β”‚    β”‚    β”‚    β”œβ”€β”€ map.html              * MapPage template
β”‚    β”‚    β”‚    └── map.ts                * MapPage code
β”‚    β”‚    β”‚    └── map.scss              * MapPage stylesheet
β”‚    β”‚    β”‚
β”‚    β”‚    │── schedule/                  * Schedule tab page
β”‚    β”‚    β”‚    β”œβ”€β”€ schedule.html         * SchedulePage template
β”‚    β”‚    β”‚    └── schedule.ts           * SchedulePage code
β”‚    β”‚    β”‚    └── schedule.scss         * SchedulePage stylesheet
β”‚    β”‚    β”‚
β”‚    β”‚    │── schedule-filter/            * Schedule Filter page
β”‚    β”‚    β”‚    β”œβ”€β”€ schedule-filter.html   * ScheduleFilterPage template
β”‚    β”‚    β”‚    └── schedule-filter.ts     * ScheduleFilterPage code
β”‚    β”‚    β”‚    └── schedule-filter.scss   * ScheduleFilterPage stylesheet
β”‚    β”‚    β”‚
β”‚    β”‚    │── session-detail/            * Session Detail page
β”‚    β”‚    β”‚    β”œβ”€β”€ session-detail.html   * SessionDetailPage template
β”‚    β”‚    β”‚    └── session-detail.ts     * SessionDetailPage code
β”‚    β”‚    β”‚
β”‚    β”‚    │── signup/                    * Signup page
β”‚    β”‚    β”‚    β”œβ”€β”€ signup.html           * SignupPage template
β”‚    β”‚    β”‚    └── signup.ts             * SignupPage code
β”‚    β”‚    β”‚
β”‚    β”‚    │── speaker-detail/            * Speaker Detail page
β”‚    β”‚    β”‚    β”œβ”€β”€ speaker-detail.html   * SpeakerDetailPage template
β”‚    β”‚    β”‚    └── speaker-detail.ts     * SpeakerDetailPage code
β”‚    β”‚    β”‚    └── speaker-detail.scss   * SpeakerDetailPage stylesheet
β”‚    β”‚    β”‚
β”‚    β”‚    │── speaker-list/              * Speakers tab page
β”‚    β”‚    β”‚    β”œβ”€β”€ speaker-list.html     * SpeakerListPage template
β”‚    β”‚    β”‚    └── speaker-list.ts       * SpeakerListPage code
β”‚    β”‚    β”‚    └── speaker-list.scss     * SpeakerListPage stylesheet
|    |    |
β”‚    β”‚    │── support/                   * Support page
β”‚    β”‚    β”‚    β”œβ”€β”€ support.html          * SupportPage template
β”‚    β”‚    β”‚    └── support.ts            * SupportPage code
β”‚    β”‚    β”‚    └── support.scss          * SupportPage stylesheet
β”‚    β”‚    β”‚
β”‚    β”‚    │── tabs/                      * Tabs page
β”‚    β”‚    β”‚    β”œβ”€β”€ tabs.html             * TabsPage template
β”‚    β”‚    β”‚    └── tabs.ts               * TabsPage code
β”‚    β”‚    β”‚
β”‚    β”‚    └── tutorial/                  * Tutorial Intro page
β”‚    β”‚         β”œβ”€β”€ tutorial.html         * TutorialPage template
β”‚    β”‚         └── tutorial.ts           * TutorialPage code
β”‚    β”‚         └── tutorial.scss         * TutorialPage stylesheet
|    |
β”‚    β”œβ”€β”€ providers/                      * Contains all Injectables
β”‚    β”‚     β”œβ”€β”€ conference-data.ts        * ConferenceData code
β”‚    β”‚     └── user-data.ts              * UserData code
β”‚    β”œβ”€β”€ theme/                          * App theme files
|    |     β”œβ”€β”€ variables.scss            * App Shared Sass Variables
|    |
|    |-- index.html
|
|-- www/
|    β”œβ”€β”€ assets/
|    |    β”œβ”€β”€ data/
|    |    |    └── data.json
|    |    |
|    |    β”œβ”€β”€ fonts/
|    |    |     β”œβ”€β”€ ionicons.eot
|    |    |     └── ionicons.svg
|    |    |     └── ionicons.ttf
|    |    |     └── ionicons.woff
|    |    |     └── ionicons.woff2
|    |    |
|    |    β”œβ”€β”€ img/
|    |
|    └── build/
|    └── index.html
|
β”œβ”€β”€ .editorconfig                       * Defines coding styles between editors
β”œβ”€β”€ .gitignore                          * Example git ignore file
β”œβ”€β”€ LICENSE                             * Apache License
β”œβ”€β”€ README.md                           * This file
β”œβ”€β”€ config.xml                          * Cordova configuration file
β”œβ”€β”€ ionic.config.json                   * Ionic configuration file
β”œβ”€β”€ package.json                        * Defines our JavaScript dependencies
β”œβ”€β”€ tsconfig.json                       * Defines the root files and the compiler options
β”œβ”€β”€ tslint.json                         * Defines the rules for the TypeScript linter
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment