Skip to content

Latest commit

 

History

History
112 lines (72 loc) · 5.49 KB

README.md

File metadata and controls

112 lines (72 loc) · 5.49 KB
Raw

Travis (.org) branch

GitHub

code style: prettier

Overview

The buyer app is the entire shopping experience from the perspective of a buyer user. This front end ecommerce application is built with Angular(7+) and is currently MVP complete meaning its ready to start taking orders!

Features

  • Open Source (free and always will be)
  • Up to three different payment methods: PurchaseOrder, CreditCard, SpendingAccount (configurable in app config)
  • Authentication - Login/Registration
  • Product search
  • Category navigation
  • Faceted navigation (API feature currently in beta)
  • Favorite Products
  • Favorite Orders
  • Personal addresses
  • Personal credit cards
  • Filterable Order History (status, search, date range)
  • Order Approvals
  • Order Comments
  • Homepage image slider
  • Featured Products (on homepage)
  • Related Products (on product detail page)
  • Product Image zoom
  • Profiled and Anonymous Shopping (toggleable in app config)

Developer Features

  • Highly tested (500+ unit tests to date and ~85% code coverage)
  • Powered by OrderCloud's strongly typed Typescript SDK
  • Modules split for organization and lazy loaded for efficiency

Roadmap

  • Multilanguage Support i18n
  • Preloading modules for greater speed
  • Angular Universal for better SEO, quicker first page load and much much more

Demo

Check out our buyer app which auto-deploys any time the master branch is updated.

Username: testbuyer
Password: fails345

Building the Buyer App Locally

  1. If you have not before, install the Angular CLI globally on your machine with npm install -g @angular/cli

  2. Navigate to the Buyer Directory with cd src/UI/Buyer

  3. Install dependencies with npm install

  4. Enter your seller organization's clientID in environment.ts (src/UI/Seller/src/environments/environment.ts)

  5. 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.

Other Useful Commands

  • Run ng test --sourceMap="false" from the root of the buyer or seller app to run unit tests.

  • Run ng build from the root of the buyer or seller app to compile the project without serving.

  • Run ng generate component component-name from any directory to generate code scafolding for a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Be sure to check out the Angular CLI docs for a full list of commands

Auto-formatter

We use a tool to auto-format code before each commit, which lets us enforce consistency in formatting. Check out the configuration file for more info on which files are formatted and formatting options.

If you use vscode we recommend installing the vscode extensions for prettier, beautify, and tslint so that you can enable the same auto-formatting on save instead of on commit.

If you want to turn this feature off completely please refer to this commit (which introduces auto-formatting) for insight on what to undo.

Theming

This app strives to make use of bootstrap variables wherever possible to make theming very easy. Want to add a new theme? Check out the README in styles/theme

Contributing

We welcomes all contributions from anyone willing to work in good faith with other contributors and the community. No contribution is too small and all contributions are valued.

Writing code may be the first thing that comes to mind when you think of contributing but there are so many different ways you can contribute even if you can't write a single line of code! Here are just a few:

  • create an issue for bugs you find
  • create an issue for possible enhancements
  • write documentation
  • improve current documentation

Issues are the primary means by which bug reports and general discussion are made. Please be sure to open an issue before you write any code with a detailed description of your problem or proposed enhancement. We may already be on our way to delivering what you want!

After you've opened an issue, received the green light to start coding, and have some code you'd like to contribute then you're ready to submit a pull request. We follow the "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

Happy contributing!

Getting Help

If you need any assistance getting set up please create a detailed github issue of what you are having trouble with and what you've tried to fix it.