traider.io
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api js formatting Aug 25, 2014
db Added Product Schema Aug 25, 2014
public Added Product Schema Aug 25, 2014
routes js formatting Aug 25, 2014
.gitignore added gitignore Aug 23, 2014
LICENCE Create LICENCE May 2, 2014
README.md Update Readme.md Aug 4, 2014
package.json Added missing module to package.json May 15, 2014
traider.js js formatting Aug 25, 2014

README.md

traider.io

Thanks for reading!

traider.io is a new open source ecommerce plaform. Although technically it's led by Eastpoint Software, it's intended to be a fully engaged community project, and we're greatly welcoming contributions from the development community.

Getting started

To get started, you'll need to:

  1. Fork a copy of the repository to your own github account
  2. Edit for copy online or clone it to your local copy using git (TODO: add more info)
  3. Ensure you have nodejs installed locally
  4. Ensure you have mongodb installed & running locally (default config expects no authentication on mongo)
  5. Resolve the dependancies on other modules by navigating to the root folder of the project in your terminal window and running "npm install" (no quotes).
  6. Start the application using the command "node traider.js", also in the app root folder.
  7. Open http://localhost:5000/api/products/seed to create some dummy product data
  8. Browse to http://localhost:5000/

To go on and contribute, please read on...

Bugs

If you find a bug in the source code or an error in the docs, please submit the issue to our issue list at https://github.com/EastpointSoftware/traider.io/issues.

Feature Requests

If you would like to request a new feature, please do so using the issues list at https://github.com/EastpointSoftware/traider.io/issues

If you would like to contribute a major new change, please get in touch through our new Google Groups forum so we can best coordinate implementing your ideas and syncronise that with other ongoing work.

Contributing

We ask that you ensure each commit and pull request relate to a single issue from the issues list. This will help us to manage the code and ensure quality throughout.

  1. Find an issue in the issues list at https://github.com/EastpointSoftware/traider.io/issues that you would like to work on.
  2. Make changes to solve the issue, git commit your changes to your github account
  3. Make a "pull request" with info about the issue resolved for us to integrate your changes into the master

Coding Expectations

Aspects to consider when writing code for traider.io. (TODO: make this more detailed and explainitory)

  • Traider.io is based on a micro-services architecture.
  • All submissions should be tested prior to submitting a pull request

Keep updated

To register your interest, please go to http://traider.io#more

Thanks again!!!