Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pkrawat1 committed Oct 9, 2018
1 parent 17bfd7c commit f129fda
Showing 1 changed file with 9 additions and 135 deletions.
144 changes: 9 additions & 135 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,156 +1,30 @@
<p align="center">
<a href="https://angularspree.firebaseapp.com/" target='_blank'>
<img alt="AngualreSpree Logo" title="AngularSpree Logo" src="https://res.cloudinary.com/mally/image/upload/v1490186051/Angular_spree_hqgwtq.png" width="200">
<img alt="AngualreSpree Logo" title="AngularSpree Logo" src="https://res.cloudinary.com/aviabird/image/upload/v1539065176/aviacommerce/logo/main.png" width="250">
</a>
</p>

<p align="center">
AngularSpree Plug and play frontend application for SPREE E-Commerce API built with ❤️ using Angular6, Redux, Observables & ImmutableJs.
</p>

<p align="center">
<a href="https://angularspree.firebaseapp.com/" target='_blank'>Check demo</a> | <a href="https://aviabird.github.io/angularspree/" target="_blank">Docs </a>
<a href="https://www.aviacommerce.org/demo/demo.html" target='_blank'>Check demo</a> | <a href="https://www.aviacommerce.org" target="_blank">Docs </a>
</p>

<p align="center">
<a href="/CONTRIBUTING.md" target='_blank'><img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"></a>
<a href="https://gitter.im/aviabird/angularspree"><img src="https://badges.gitter.im/aviabird/angularspree.svg"/></a>
<a href="https://gitter.im/avia-commerce/Lobby"><img src="https://badges.gitter.im/aviabird/angularspree.svg"/></a>
<a href="https://www.pivotaltracker.com/n/projects/2165435" target='_blank'><img alt="Pivotal Project page" src="https://res.cloudinary.com/zeus999/image/upload/c_limit,h_1041,w_1487/v1486457388/Yatrum%20Logo/pt-badge_ss3dyt.svg"></a>
</p>

<p align="center">
<a href="https://teracommerce.in" target="_blank"><img alt="TeraCommerce Bundle" src="https://res.cloudinary.com/ashish173/image/upload/v1506115865/Full_E-COMMERCE_BUNDL_3_km1yzz.jpg"></a>
<p>
<a href="https://aviacommerce.org" target="_blank"><img alt="Aviacommerce" src="https://res.cloudinary.com/aviabird/image/upload/v1539069450/aviacommerce/flyer.jpg"></a>
</p>

AngularSpree is an open source Angular(6.x+) front-end application for [Aviacommerce](https://github.com/aviacommerce/avia).

### :rocket: **Progressive Web App:** [Lighthouse](https://github.com/GoogleChrome/lighthouse) score of __95/100__.

## What is AngularSpree?

AngularSpree is an open source Angular(6.x+) front-end application for [Spree Commerce](https://github.com/spree/spree).
**It's free and always will be**.
It is a plug and play frontend application for AviaCommerce API built with ❤️ using Angular6, Redux, Observables & ImmutableJs.

**Bootstrap 4 Compatible**
However, it is not limited to aviacommerce and can also be used with any e-commerce solution with api interface.

Go ahead use it the way you want to or let us know at `[email protected]` if you need any help with this project.

### Quick Links
[Gitter](https://gitter.im/aviabird/angularspree) | [Contributing](https://github.com/aviabird/angularspree/blob/master/CONTRIBUTING.md) | [Wiki](https://github.com/aviabird/angularspree/wiki) |
[Gitter](https://gitter.im/avia-commerce/Lobby) | [Contributing](https://github.com/aviabird/angularspree/blob/master/CONTRIBUTING.md) | [API Specs](https://www.aviacommerce.org/docs/apis-getting-started.html) |
|---|---|---|

## Why did we build it?

We have been working with Spree for very long time, making products for a lot of clients. There was one pattern we noticed in what the clients always asked for. They were comfortable using spree for the backend [API](http://guides.spreecommerce.org/api/) but not for the front-end. These requests have been very consistent with so many awesome [front-end framework](https://github.com/showcases/front-end-javascript-frameworks) around.

When Angular team released the beta version in March last year we knew that angular was going to be a big player soon.
We decided to give it a try. Hence, AngularSpree was born as a front-end framework for the most awesome backend api for E-Commerce out there.

🔥🔥🔥🔥🔥🔥🔥🔥🔥

If you are looking to build a project similar to this one with all the ready-made setup, then I highly encourage you to look at this [starter seed project](https://github.com/aviabird/angular-seed) by [Aviabird Team](https://aviabird.com).

**[AngularSeed](https://github.com/aviabird/angular-seed) is a Plug and play Seed project built with ❤️ using Angular 6+, Redux/ngrx-store 6, Observables & ImmutableJs. We are commited to keeping this project upto date with all the latest versions of all the libs and components.**

🔥🔥🔥🔥🔥🔥🔥🔥🔥

## What's included?

Currently, this is a fairly basic vesion of the application. We are calling it a pre-alpha release.

### What's working and ready to be deployed?

* Add/Remove products to cart.
* Select/Clear filters based on category.
* Support for product variants.
* Cart checkout feature.
* Cash on delivery option.
* Authentication (Login/Signup)
* More sorting features(Relevance, Newest, Price[low,high], Name[A-Z/Z-A])
* google login support.
* Add to favourite products.
* New landing page
* Search page and feature
* Product image zoomer
* Product Review and Rating feature

### What's coming very soon?

* __Angular Universal__ support for better SEO and [much more](https://github.com/angular/angular/issues/13822).
* __Payment__ options credit/debit cards.
* __Multilanguage__ Support i18n.
* Support for further types of products(size, pattern, collar, etc).
* Support for further options in types eg. size(32, 34, 36) etc. etc.
* Ability to add more than one addresses.
* and many more....

There is a long way to go... keep an eye on this [project](https://github.com/aviabird/angularspree/) here on github.

## Angular 6 Fundamentals course

Based on this application and **[other applications](https://github.com/aviabird/yatrum)** we have built in past we are working on a full blown Angular 6 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/)__

## What in the Tech News?

We've built AngularSpree keeping scaling in mind leveraging the best technologies out there.

As of now, the application has 7 major modules, `products`, `core`, `search`, `user`, `checkout`, `auth`, `shared`.

We are working on documentation and we can share that once we are looking at a more stable release.

* Exclusively using @ngrx libraries(store, effects, actions), showcasing common patterns and best practices.
* Fully Observable approach using RxJS 6.
* Uses @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.
* @ngrx/actions to define the actions on the frontend.
* Following Container/Presentation component approach.
* Lazy loading of modules(for modules which are not immediately required for first painting the DOM).
* ImmutableJs to create and safeguard objects againts mutability.
* Project is divided into modules which are more or less independant of each other except core module.

__Current version of Angular is latest release [6.0.3](https://github.com/angular/angular/releases/tag/6.0.3).__

__Current version of Angular-cli is [6.0.3](https://github.com/angular/angular-cli/releases/tag/v6.0.3).__

We try to make sure that we keep the repository upto date with the angular release every weekend.

## DEMO
Video coming soon

## Who are we?

We are [Aviabird Technologies](https://aviabird.com).

__We love to create awesome Web & Mobile products.__

__We are very proud of our work.__

We love technologies like Golang, Elixir, Scala, Ruby, Javascript, Typescript, Swift, Java.

We love some frameworks too:-

* Ruby On Rails
* Phoenix/Elixir framework.
* Spring framework.
* AngularJs (1.x+ & 2.x+)
* ReactJs
* BackboneJs

### We are avialible for hire

__If you want to hire us for a project, please contact us on `[email protected]`.__

0 comments on commit f129fda

Please sign in to comment.