Commit b7f3d3a245fa70446ae56889e772dd2bbf7af41f
1 parent
7782e943
Exists in
master
and in
1 other branch
Improve readme
Showing
1 changed file
with
17 additions
and
4 deletions
Show diff stats
README.md
| @@ -6,11 +6,24 @@ The Noosfero theme that uses the API to create a totally new client-side fronten | @@ -6,11 +6,24 @@ The Noosfero theme that uses the API to create a totally new client-side fronten | ||
| 6 | 6 | ||
| 7 | ### How to Install | 7 | ### How to Install |
| 8 | 1. Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) | 8 | 1. Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) |
| 9 | -2. Install [Bower](http://bower.io/): `npm install -g bower` | ||
| 10 | -3. Install Node.js dependencies: `npm install` | ||
| 11 | -4. Install bower dependencies: `bower install` | ||
| 12 | -5. Build the project: `gulp build` | 9 | +1. Install [Bower](http://bower.io/): `npm install -g bower` |
| 10 | +1. Install Node.js dependencies: `npm install` | ||
| 11 | +1. Install bower dependencies: `bower install` | ||
| 12 | +1. Build the project: `gulp build` | ||
| 13 | 13 | ||
| 14 | ### How to Use | 14 | ### How to Use |
| 15 | 15 | ||
| 16 | Just set the profile theme to `angular-theme`. | 16 | Just set the profile theme to `angular-theme`. |
| 17 | + | ||
| 18 | + | ||
| 19 | +## Project Structure | ||
| 20 | +The folder structure of this project was sorted by feature. | ||
| 21 | +See some important folders bellow: | ||
| 22 | + | ||
| 23 | +- Directives for blocks: `src/app/components/noosfero-blocks` | ||
| 24 | +- Directives for articles: `src/app/components/noosfero-articles` | ||
| 25 | +- Directives for activities: `src/app/components/noosfero-activities` | ||
| 26 | +- Service to connect with Noosfero API: `src/app/components/noosfero` | ||
| 27 | +- Content viewer controller: `src/app/content-viewer` | ||
| 28 | +- Profile controller: `src/app/profile` | ||
| 29 | +- Profile info controller: `src/app/profile-info` |