Skip to content

Commit

Permalink
updated dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
@jonniespratley
jonniespratley committed Dec 4, 2014
1 parent f322fd5 commit f8cd965
Show file tree
Hide file tree
Showing 3 changed files with 139 additions and 142 deletions.
213 changes: 105 additions & 108 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,35 +1,39 @@
# Angular CMS
Angular CMS
===========

This is a boilerplate CMS built with Angular, Twitter Bootstrap and Node; it is in development stage and aims to offer a quick start for creating full-stack angular application.

[![Build Status](https://travis-ci.org/jonniespratley/angular-cms.png)](https://travis-ci.org/jonniespratley/angular-cms)

[![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/jonniespratley/angular-cms/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/jonniespratley/angular-cms/trend.png)](https://bitdeli.com/free)

[![Coverage Status](https://coveralls.io/repos/jonniespratley/angular-cms/badge.png)](https://coveralls.io/r/jonniespratley/angular-cms)
[![Coverage Status](https://coveralls.io/repos/jonniespratley/angular-cms/badge.png)](https://coveralls.io/r/jonniespratley/angular-cms)[![Dependency Status](https://david-dm.org/jonniespratley/angular-cms.svg)](https://david-dm.org/jonniespratley/angular-cms)

### Technologies
Some featured technologies used in this project include the following:

* **MongoDB** - The database of choice is Mongo, its fast, easy and scalable.
* **NodeJS** - The server of choice is Node, its JavaScript, its fast and scalable.
* **AngularJS** - The client-side framework of choice is Angular, its a full-stack, just what we need.
* **Bootstrap** - The client-side ui of choice is Twitter Bootstrap, its updated and clean.
* **HTML5** - Using HTML5 in every way to make a better user experience.
* **Protractor** - Using Protractor for all e2e testing.
* **Karma** - The test runner is Karma.
Some featured technologies used in this project include the following:

- **MongoDB** - The database of choice is Mongo, its fast, easy and scalable.
- **NodeJS** - The server of choice is Node, its JavaScript, its fast and scalable.
- **AngularJS** - The client-side framework of choice is Angular, its a full-stack, just what we need.
- **Bootstrap** - The client-side ui of choice is Twitter Bootstrap, its updated and clean.
- **HTML5** - Using HTML5 in every way to make a better user experience.
- **Protractor** - Using Protractor for all e2e testing.
- **Karma** - The test runner is Karma.

Getting Started
---------------

## Getting Started
To get started on developing with this code base you can either fork the repository or clone it using the following command:

```
$ git clone https://github.com/jonniespratley/angular-cms.git
```

### Step 1 - Install NPM dependencies

Before you can run or build the application you need to install the dependencies, execute the following command:

```
Expand All @@ -38,15 +42,16 @@ $ npm install

> **Note:** You may need to run this as a `sudo` user.

### Step 2 - Install Bower dependencies

Now you need to install the client-side dependencies that is managed by bower, execute the following command:

```
$ bower install
```

### Step 3 - Start Grunt server

Now you are ready to run the preview server that is used for development, execute the following command:

```
Expand All @@ -55,20 +60,23 @@ $ grunt serve

> **Note:** Your default browser should open up to [http://localhost:9000](http://localhost:9000)
Running the application
-----------------------


## Running the application
To run the application on your local machine please take the following steps.


#### Step 1 - Start mongodb

To start mongodb execute the following command:

$ sh ./bin/db.sh

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

> **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 @@ -77,107 +85,96 @@ $ node server

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




## Development
The following sections are different development tasks that I generally run while developing features.


### Karma Unit Tests

To run the Karma unit tests execute the following command:

```
$ grunt test
```

### Karma e2e Scenario Tests

To run the Karma scenario tests take the following steps:

1. Start Node server - `$ grunt serve`
2. Start REST server - `$ node server`
3. Start DB server - `$ sh bin/db.sh`
4. Now run the e2e tests by executing:
1. Start Node server - `$ grunt serve`
2. Start REST server - `$ node server`
3. Start DB server - `$ sh bin/db.sh`
4. Now run the e2e tests by executing:

```
$ grunt test:e2e
```

> **Note:** Each step is a ‘new’ terminal window

### Protractor e2e Tests

To run the Protractor e2e tests take the following steps:

1. Start Node server - `$ grunt serve`
2. Start REST server - `$ node server`
3. Start DB server - `$ sh bin/db.sh`
4. Now run the Protractor tests by executing:
1. Start Node server - `$ grunt serve`
2. Start REST server - `$ node server`
3. Start DB server - `$ sh bin/db.sh`
4. Now run the Protractor tests by executing:

```
$ grunt protractor
```

> **Note:** Each step is a ‘new’ terminal window









---

## 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).
RESTful Server
--------------

The base URL is `http://localhost:8181/api/v2`
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
------------ | ------------- | ------------
GET | findAll | /database/table
GET | findById | /database/table/:id
POST | add | /database/table
PUT | update | /database/table/:id
DELETE | destroy | /database/table/:id
| HTTP | METHOD | ENDPOINT |
|--------|----------|---------------------|
| GET | findAll | /database/table |
| GET | findById | /database/table/:id |
| POST | add | /database/table |
| PUT | update | /database/table/:id |
| DELETE | destroy | /database/table/:id |

> **Tip:** To create new collection open `http://localhost:8181/api/v2/[DATABASE]/[COLLECTION]` in browser.
---

WebSocket Server
----------------

## WebSocket Server
This is a socket server implementation for "real" time.


### WebSocket Channels
These are the events that this socket server dispatches.

These are the events that this socket server dispatches.

1. cms:authorization
2. cms:client:message
3. cms:client:connect
4. cms:client:disconnect
5. cms:server:message
6. cms:server:disconnect
7. cms:server:connect

1. cms:authorization
2. cms:client:message
3. cms:client:connect
4. cms:client:disconnect
5. cms:server:message
6. cms:server:disconnect
7. cms:server:connect

---

Themes
------




## Themes
Themes will be installed via `bower`, search and install themes searching by tag `angular-cms`.

### Structure of theme

This is the structure of the themes.

```
Expand All @@ -194,7 +191,7 @@ my-theme/
sidebar.html
footer.html
content.html
```
```



Expand All @@ -211,68 +208,68 @@ 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:

```
$ grunt docs
```
> Your default browser should open [http://127.0.0.1:9191/#/api](http://127.0.0.1:9191/#/api)
$ grunt docs\`\`\`
_(Coming soon)_
> Your default browser should open [http://127.0.0.1:9191/#/api](http://127.0.0.1:9191/#/api)
*(Coming soon)*
---
Important notes
---------------
## Important notes
Please don't edit files in the `dist` subdirectory as they are generated via Grunt. You'll find source code in the `app` subdirectory! Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.**
Modifying the code
------------------
## Modifying the code
First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
Test that Grunt's CLI and Bower are installed by running `grunt --version` and `bower --version`.
Test that Grunt's CLI and Bower are installed by running `grunt --version` and `bower --version`.
1. Fork and clone the repo.
1. Run `npm install` to install all build dependencies (including Grunt).
1. Run `bower install` to install the front-end dependencies.
1. Run `grunt` to grunt this project.
1. Fork and clone the repo.
2. Run `npm install` to install all build dependencies (including Grunt).
3. Run `bower install` to install the front-end dependencies.
4. Run `grunt` to grunt this project.
Assuming that you don't see any red, you're ready to go. Just be sure to run `grunt` after making any changes, to ensure that nothing is broken.
Submitting pull requests
------------------------

## Submitting pull requests

1. Create a new branch, please don't work in your `master` branch directly.
1. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
1. Fix stuff.
1. Run `grunt` to see if the tests pass. Repeat steps 2-3 until done.
1. Update the documentation to reflect any changes.
1. Push to your fork and submit a pull request.
1. Create a new branch, please don't work in your `master` branch directly.
2. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
3. Fix stuff.
4. Run `grunt` to see if the tests pass. Repeat steps 2-3 until done.
5. Update the documentation to reflect any changes.
6. Push to your fork and submit a pull request.
---
## TODO
The following list is features that are comming.
TODO
----
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)
- 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)
---

Loading

0 comments on commit f8cd965

Please sign in to comment.