Skip to content

Commit

Permalink
fixed readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jonniespratley committed Dec 17, 2014
1 parent 6d171db commit 97fe428
Showing 1 changed file with 7 additions and 24 deletions.
31 changes: 7 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,13 @@ To run the application on your local machine please take the following steps.

To start mongodb execute the following command:

\<\<\<\<\<\<< HEAD

```
$ sh ./bin/db.sh
$ sh bin/db.sh
```

======= $ sh ./bin/db.sh >>>>>>> fe4af0e14ef3596c823d4777d672ba00406ddb90

> **Note:** If errors when executing command remove the `db/mongod.lock` file.

#### Step 2 - Start REST server

To start the server execute the following command:
Expand All @@ -97,6 +94,8 @@ $ node server

> **Note:** The REST server is running at [http://localhost:8181/api/v2](http://localhost:8181/api/v2)


Development
-----------

Expand Down Expand Up @@ -142,20 +141,11 @@ $ grunt protractor
---

\<\<\<\<\<\<< HEAD

RESTful Server
--------------

=======

RESTful Server
--------------

The server is a Node.js server that supports dynamic RESTful API calls to resource endpoints. It will automatically create a database if it does not exist and collection(s). >>>>>>> fe4af0e14ef3596c823d4777d672ba00406ddb90

The server is a Node.js server that supports dynamic RESTful API calls to resource endpoints. It will automatically create a database if it does not exist and collection(s).

The base URL is `http://localhost:8181/api/v2`

| HTTP | METHOD | ENDPOINT |
Expand Down Expand Up @@ -228,7 +218,9 @@ Plugins will be installed via `bower`, search and install themes searching by ta
API Documentation
-----------------

The API documentation will be in the form of ngDocs style. The files located in the `content` directory are tutorial specs for the different features in this project. Documentation can be generated and viewed by running the following command:
The API documentation will be in the form of ngDocs style.
The files located in the `content` directory are tutorial specs for the different features in this project.
Documentation can be generated and viewed by running the following command:

\`\`\`

Expand Down Expand Up @@ -279,19 +271,10 @@ The following list is features that are comming.
- user management & user roles
- action and view permissions
- content versioning and audit
- some form of workflow and notifications
- i18n support on literals and object versions
- normalized database schema design
- some form of content import-export
- assets management and thumbnail generation for uploads
- Valid XHTML (compressed with GZIP)
- Rich text editing (e.g FCKeditor) which generates accessible markup
- Valid and minified CSS and javascript (e.g using YUI)
- automatically generated sitemaps.org document
- integration with Google Analytics
- automatic RSS feeds
- open search support
- print css and/or print versions of content
- SEO consideration for duplicate content (e.g use of canonical tag)

---

0 comments on commit 97fe428

Please sign in to comment.