Update README.md
This commit is contained in:
parent
3fb24954c6
commit
3159473021
31
README.md
31
README.md
|
@ -6,30 +6,8 @@ MEDFORMS
|
|||
|
||||
Medforms is an opensource *form builder* that can create stunning forms from PDFs or from scratch
|
||||
|
||||
## Before You Begin
|
||||
Before you begin we recommend you read about the basic building blocks that assemble a MEAN.JS application:
|
||||
* MongoDB - Go through [MongoDB Official Website](http://mongodb.org/) and proceed to their [Official Manual](http://docs.mongodb.org/manual/), which should help you understand NoSQL and MongoDB better.
|
||||
* Express - The best way to understand express is through its [Official Website](http://expressjs.com/), which has a [Getting Started](http://expressjs.com/starter/installing.html) guide, as well as an [ExpressJS Guide](http://expressjs.com/guide/error-handling.html) guide for general express topics. You can also go through this [StackOverflow Thread](http://stackoverflow.com/questions/8144214/learning-express-for-node-js) for more resources.
|
||||
* AngularJS - Angular's [Official Website](http://angularjs.org/) is a great starting point. You can also use [Thinkster Popular Guide](http://www.thinkster.io/), and the [Egghead Videos](https://egghead.io/).
|
||||
* Node.js - Start by going through [Node.js Official Website](http://nodejs.org/) and this [StackOverflow Thread](http://stackoverflow.com/questions/2353818/how-do-i-get-started-with-node-js), which should get you going with the Node.js platform in no time.
|
||||
|
||||
|
||||
## Prerequisites
|
||||
Make sure you have installed all of the following prerequisites on your development machine:
|
||||
* Node.js - [Download & Install Node.js](http://www.nodejs.org/download/) and the npm package manager. If you encounter any problems, you can also use this [GitHub Gist](https://gist.github.com/isaacs/579814) to install Node.js.
|
||||
* MongoDB - [Download & Install MongoDB](http://www.mongodb.org/downloads), and make sure it's running on the default port (27017).
|
||||
* Bower - You're going to use the [Bower Package Manager](http://bower.io/) to manage your front-end packages. Make sure you've installed Node.js and npm first, then install bower globally using npm:
|
||||
|
||||
```bash
|
||||
$ npm install -g bower
|
||||
```
|
||||
|
||||
* Grunt - You're going to use the [Grunt Task Runner](http://gruntjs.com/) to automate your development process. Make sure you've installed Node.js and npm first, then install grunt globally using npm:
|
||||
|
||||
```bash
|
||||
$ npm install -g grunt-cli
|
||||
```
|
||||
|
||||
## Quickstart
|
||||
|
||||
Install dependencies first.
|
||||
|
@ -38,9 +16,14 @@ $ npm install
|
|||
$ bower install
|
||||
```
|
||||
|
||||
Then run your application using grunt.
|
||||
To run development version:
|
||||
```bash
|
||||
$ grunt
|
||||
$ grunt default
|
||||
```
|
||||
|
||||
To run production version:
|
||||
```bash
|
||||
$ grunt production
|
||||
```
|
||||
|
||||
Your application should run on port 3000, so in your browser just go to [http://localhost:3000](http://localhost:3000)
|
||||
|
|
Loading…
Reference in a new issue