Skip to content

Commit ff28664

Browse files
committed
Update description
1 parent 7d091be commit ff28664

File tree

1 file changed

+25
-17
lines changed

1 file changed

+25
-17
lines changed

README.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
1-
# Code Express ORM MariaDB
1+
# Code REST API ORM SQL Database
22

3-
Express-based REST API server with ORM and MariaDB/MySQL.
3+
Code example to build a REST API with ORM and SQL Database.
4+
5+
Technologies:
6+
7+
- [Express](https://expressjs.com) REST API server
8+
- [Sequelize](http://docs.sequelizejs.com) ORM
9+
- [MariaDB](https://mariadb.org)/[MySQL](https://mysql.com) database
410

511
---
612

713
## Preparation
814

915
### Database Installation
1016

17+
We recommend using `mariadb` instead of `mysql`. Although the `node` adapter can be using `mysql2` adapter.
18+
1119
**macOS:**
1220

1321
```sh
@@ -178,47 +186,47 @@ Change the `server.listen` code block.
178186

179187
```js
180188
server.listen(port, function() {
181-
console.log('Express server listening on port ' + server.address().port);
182-
});
183-
server.on('error', onError);
184-
server.on('listening', onListening);
189+
console.log('Express server listening on port ' + server.address().port)
190+
})
191+
server.on('error', onError)
192+
server.on('listening', onListening)
185193
```
186194

187195
Into this, to be wrapped with `models.sequelize`.
188196

189197
```js
190-
const models = require('./models');
198+
const models = require('./models')
191199

192200
// ...
193201

194202
models.sequelize.sync().then(function() {
195203
server.listen(port, function() {
196-
console.log('Express server listening on port ' + server.address().port);
197-
debug('Express server listening on port ' + server.address().port);
198-
});
199-
server.on('error', onError);
200-
server.on('listening', onListening);
201-
});
204+
console.log('Express server listening on port ' + server.address().port)
205+
debug('Express server listening on port ' + server.address().port)
206+
})
207+
server.on('error', onError)
208+
server.on('listening', onListening)
209+
})
202210
```
203211

204212
Use the model from anywhere. For instance, in your controller functions.
205213

206214
```js
207-
const models = require('../../models');
215+
const models = require('../../models')
208216

209217
// ...
210218

211219
models.User.findAll()
212220
.then(users => {
213221
res.send({
214222
users
215-
});
223+
})
216224
})
217225
.catch(error => {
218226
res.status(400).send({
219227
error
220-
});
221-
});
228+
})
229+
})
222230
```
223231

224232
Run `express` server as usual.

0 commit comments

Comments
 (0)