Express-based REST API server with ORM and MariaDB/MySQL.
macOS:
brew install mariadb
brew services start mariadbUbuntu:
- Install MariaDB 10.3 on Ubuntu 18.04 and CentOS 7 - Computingforgeeks
- How To Install MySQL on Ubuntu 18.04 | DigitalOcean
Install dependencies:
yarnRun setup script:
yarn setup
# this will copy .env.schema to .envThen edit .env contents in your editor:
DB_USERNAME=yourusername
DB_PASSWORD=yourpassword
DB_NAME=yourdatabase
DB_HOST=localhost
DB_PORT=3306
DB_DIALECT=mysql
Create the yourdatabase (change this) database to your own database server.
Run migrate script to migrate the tables and seed data into the database.
yarn migrateyarn devyarn start| Endpoint | HTTP | Description |
|---|---|---|
/ |
GET | Get root API |
/users |
GET | Get all users |
/users/:id |
GET | Get one user by id |
/users |
POST | Create new user |
/users/:id |
PUT | Update one user by id |
/users/:id |
DELETE | Delete one user by id |
/users |
DELETE | Delete all users |
Request body example
{
"email": "[email protected]",
"password": "yourpassword",
"username": "yourusername",
"name": "Your Full Name"
}
Users
{
"id": 0,
"email": "",
"password": "",
"salt": "",
"username": "",
"name": ""
}Tasks
{
"id": 0,
"user_id": 0,
"text": ""
}Follow this official guide: http://docs.sequelizejs.com/manual/tutorial/migrations.html
Install sequelize dependencies in your project.
yarn add sequelize mysql2 mariadb sqlite3Use sequelize-cli to initialize and configure the project.
# install sequelize-cli globally
yarn global add sequelize-cli sequelize mysql2 mariadb sqlite3
# so you can use it anywhere
sequelize init
# change config.json to config.js
# change '/../config/config.js' in models/index.js
# configure config.js based on your database settings
# change database name, username, password, host, port, dialect
# generate model via cli
sequelize model:generate --name User --attributes username:string,email:string
# edit migrations file
# migrations/20180000000000-create-user.js
# edit models file
# models/user.js
# do the migration from the configuration to the actual database
sequelize db:migrate
# generate seeder via cli
sequelize seed:generate --name demo-users
# edit seeders file
# seeders/20180000000000-demo-users.js
# do the seeding from the configuration to the actual database
sequelize db:seed:allChange the server.listen code block.
server.listen(port, function() {
console.log('Express server listening on port ' + server.address().port);
});
server.on('error', onError);
server.on('listening', onListening);Into this, to be wrapped with models.sequelize.
const models = require('./models');
// ...
models.sequelize.sync().then(function() {
server.listen(port, function() {
console.log('Express server listening on port ' + server.address().port);
debug('Express server listening on port ' + server.address().port);
});
server.on('error', onError);
server.on('listening', onListening);
});Use the model from anywhere. For instance, in your controller functions.
const models = require('../../models');
// ...
models.User.findAll()
.then(users => {
res.send({
users
});
})
.catch(error => {
res.status(400).send({
error
});
});Run express server as usual.
How to backup/export & restore/import database from/to a file.
Export:
mysqldump yourdatabase --single-transaction --user=yourusername -p > yourfile.sqlImport:
mysql yourdatabase --user=yourusername -p < yourfile.sql
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent