Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aviabird/yatrum
Yatrum - Share and Discover Travel Stories, Itineraries, Travel Guides built with ♥️ using Angular 4.0.0
https://github.com/aviabird/yatrum
angular angular-2 aviabird ngrx opensource redux
Last synced: 26 days ago
JSON representation
Yatrum - Share and Discover Travel Stories, Itineraries, Travel Guides built with ♥️ using Angular 4.0.0
- Host: GitHub
- URL: https://github.com/aviabird/yatrum
- Owner: aviabird
- License: mit
- Created: 2016-11-24T15:08:29.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-30T10:03:57.000Z (over 7 years ago)
- Last Synced: 2024-09-28T17:21:28.693Z (about 1 month ago)
- Topics: angular, angular-2, aviabird, ngrx, opensource, redux
- Language: TypeScript
- Homepage: https://yatrum.firebaseapp.com
- Size: 67.9 MB
- Stars: 352
- Watchers: 36
- Forks: 138
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: License.md
Awesome Lists containing this project
README
Yatrum built with ❤️ using Angular2, ngrx store, observables and reactive forms.
## What's included?
* Yatrum uses @ngrx libraries, showcasing common patterns and best practices.
* Yatrum is a travel diary app for travellers.
* Travellers can create itinerary for their trips.
* This application utilises @ngrx/store to manage the state of the app and to cache requests made to the Backend API, @angular/router to manage navigation between routes, @ngrx/effects to isolate side effects.
## AngularSpree
We have also created and open sourced __[AngularSpree](https://github.com/aviabird/angularspree)__: Plug and play frontend application for SPREE E-Commerce API built with ❤️ using Angular2, Redux, Observables & ImmutableJs.
Check it out and join the our team on it's __[slack channel](https://angular-spree.herokuapp.com/)__ for discussions related to AngularSpree.
## Angular Fundamentals Course
Based on this application we are working on a full blown Angular 2 fundamentals course on udemy. Throughout this course you'll learn how to build yatrum from ground up.
#### Course curriculum
* Architecture, setup, source files
* TypeScript basics
* Getting started with latest angular
* Template fundamentals
* Rendering flows
* Component Architecture and Modules
* Services, Http and Observables
* Template Forms, Inputs and Validation
* Reactive Forms and more magic
* Routing
__[Subscribe to this course here](https://upscri.be/a00eaf/)__
## Setting up
##### Clone the repoo
```
$ git clone https://github.com/aviabird/yatrum.git
$ cd yatrum
```
##### Install npm dependencies
```
$ npm install
```
##### Additional Settings
For Social login to work you need to create an app on faceook and google and note down the client id and secret id of individual app.
Below are instructions for creating app on inidviudal social media site
1. Google : [Creating App Engine Project and Application](https://developers.google.com/ad-exchange/rtb/open-bidder/google-app-guide)
2. Facebook : [Creating a New Facebook App](https://developers.facebook.com/docs/apps/register)
Once you have created the app,rename `secret.ts.example` file in `app` folder to `secret.ts` and replace the dummy string with client id of respective social app.
## Development server frontend
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
By default it connects to our dev api. If you want to setup the server locally clone the [api](https://github.com/aviabird/yatrum-api) and setup the rails server, However we only suggest that if you are familiar with Ruby on Rails. Please follow the instructions on the project page as the frontend uses the backend API to connect.
## Running unit tests
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
## Running end-to-end tests
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
Before running the tests make sure you are serving the app via `ng serve`.
## Deploying to Github Pages
Run `ng github-pages:deploy` to deploy to Github Pages.
## License
[MIT License](LICENSE.md)