| 1 | # Igo.js [](https://travis-ci.org/igocreate/igo)
|
| 2 |
|
| 3 | Igo is a Web Framework for Node.js that comes with:
|
| 4 | - Pre-configured Express, middlewares, and Dust
|
| 5 | - Pre-configured [Webpack](https://webpack.js.org) and [Nodemon](https://nodemon.io/)
|
| 6 | - Full-featured testing environment based on [Mocha](https://mochajs.org/)
|
| 7 | - Basic ORM for MySQL
|
| 8 |
|
| 9 | All remarks, suggestions, PRs are welcome! 💕
|
| 10 |
|
| 11 | # 🚀 Getting Started
|
| 12 |
|
| 13 | Before using Igo, you need to install Node.js (>=6.x) and Mocha.
|
| 14 | Then, you can easily create a new project via the `igo` CLI.
|
| 15 |
|
| 16 | ```sh
|
| 17 | npm install -g igo mocha
|
| 18 | igo create myproject
|
| 19 | cd myproject
|
| 20 | npm install
|
| 21 | npm start
|
| 22 | ```
|
| 23 |
|
| 24 | Open [http://localhost:3000](http://localhost:3000) and start coding (and reading [the docs](/docs/README.md)).
|
| 25 |
|
| 26 | Type ```mocha``` to run tests.
|
| 27 |
|
| 28 | # Documentation
|
| 29 |
|
| 30 | - [Introduction](/docs/introduction.md)
|
| 31 | - Presentation, Installation, Getting Started, Configuration
|
| 32 | - [Models](/docs/models.md)
|
| 33 | - MySQL configuration, SQL migrations, Model API
|
| 34 | - [Views](/docs/views.md)
|
| 35 | - Template syntax, I18n, View helpers
|
| 36 | - [Controllers](/docs/controllers.md)
|
| 37 | - Routes, Middlewares
|
| 38 | - [Development](/docs/development.md)
|
| 39 | - Webpack, Nodemon
|
| 40 | - [Test](/docs/test.md)
|
| 41 | - Using Mocha, testing controllers
|
| 42 | - [Production](/docs/production.md)
|
| 43 | - Running Igo in production, receiving email alerts
|
| 44 | - Other features
|
| 45 | - [Cache](/docs/cache.md) : Cache API
|
| 46 | - Igo Mailer : TODO
|
| 47 | - Igo Logger : TODO
|
| 48 | |
| \ | No newline at end of file |