The website is based on:
- MEAN.JS 0.4.0 a Node.js development framework.
To make getting started as easy as possible we are using:
- Docker to provide "containers" to run our app and its dependant services in
These allow our application to run happily and consistently on Linux, MacOSX and Windows in only a few commands.
- Install Docker
$ git clone https://github.com/newcrossfoodcoop/nxfc.git nxfc
This will clone the latest version of the repository to a nxfc folder.
$ docker-compose up
Docker will now download a couple of container images, build them and then run them, this could take a few minutes the first time but will be much quicker the next time.
The website should now be running on the 3000 port so in your browser just go to http://localhost:3000
That's it! You should now have two containers running one running mongodb and one running the website.
Head to the wiki to find out how to work with the app.
We intend to follow the standard open source approach for contributing to a project hosted on github that you can find here. Basically:
- fork the repo
- clone it locally
- make your changes in a branch
- push them to your fork
- open a pull request
(The MIT License)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.