https://github.com/niftymonkey/order-form
Simple web-based application for ordering items.
https://github.com/niftymonkey/order-form
Last synced: 4 months ago
JSON representation
Simple web-based application for ordering items.
- Host: GitHub
- URL: https://github.com/niftymonkey/order-form
- Owner: niftymonkey
- Created: 2014-01-12T04:35:16.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2014-11-29T15:40:12.000Z (over 11 years ago)
- Last Synced: 2024-04-14T11:13:33.349Z (about 2 years ago)
- Language: JavaScript
- Homepage: http://nifty-order-app.herokuapp.com/
- Size: 15.1 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Order Application
[](https://travis-ci.org/niftymonkey/order-form)
Simple web-based application for ordering items.
## Live Demo
http://nifty-order-app.herokuapp.com/
> Note: Demo is running on Heroku free instance, so you may have to refresh for it to load.
## Motivation
### Real-world Need
This application is being built for a specific usecase (user). It will change a lot over time. It will start out as a simple form that can be used to email order to a set email address. It will then evolve into a more "shopping cart" type workflow. And lastly will likely end up being the centerpiece of a website for this user's business.
### Learning Experience
This is also intended to be a project that I can use to learn the technologies in the [MEAN stack][1] in a hands-on way. As a result, things may change drastically over time as I learn better/faster/smarter ways of solving the software engineering problems I encounter when building this application.
## Contributing
Since this is intended to be a learning experience for me, I don't expect that anyone else will be running this application locally. However, if you'd like to build, run, and test this application locally, here's what you'll need to do:
### Manual Dependencies
You will need to install the following manually as a starting point:
* [NodeJS][2] - server code and build platform
* [MongoDB][3] - database used by server
* Sass Compiler - Sass precompiler used while developing
- [Ruby][4] - Needed by compass/sass compiler
- Sass gem - Type the following once Ruby is installed:
```
gem install sass
```
- Compass gem - Type the following once Sass is installed:
```
gem install compass
```
### Get Started
#### Clone
git clone https://github.com/niftymonkey/order-form.git
cd order-form
#### Run the app
Among other things, this will install dependencies, build, start a watch on the source files, start a server, and launch your default browser to the app. It will also auto-reload when you make changes to the source files.
npm start
Alternatively, once you've installed all dependencies, you can simply run the application in development or production mode using the grunt tasks.
##### Development
grunt serve
##### Production
grunt serve:dist
#### Run the tests
If you want to run the tests, it's a simple command as well
npm test
Or the alternative grunt task
grunt test
#### Misc Grunt Tasks
You can run the following and check the "Available Tasks" for a list of other tasks you can run on the command-line
grunt --help
[1]:http://www.mean.io/
[2]:http://nodejs.org/
[3]:http://www.mongodb.org/
[4]:https://www.ruby-lang.org/en/downloads/