- Clone This Repository Using HTTPS
git clone https://github.com/firmanJS/knex-express-for-backend-team.git
cd existing_reporunning application three methods manually, using docker or via Makefile
- Manually :
# Copy enviroment variables from .env.sample to .env
cp .env.sample .env
# Copy Makefile sesuai environment
cp Makefile.sample Makefile
# Install package via npm or yarn
npm install
# Run application via npm or yarn
npm run dev
# Run migration or create migration file
npm i -g knex
# Create migration
knex migrate:make create_users_table --cwd=src
# Run migration
knex migrate:latest --cwd=src
# Create Seed
knex seed:make users_seed --cwd=src
# Run Seed
knex seed:run --cwd=src- Via Docker :
# Copy enviroment variables from .env.sample to .env
cp .env.sample .env
# Copy Makefile sesuai environment
cp Makefile.sample Makefile
# Build application
docker-compose -f docker-compose-dev.yml up --build --remove-orphans --force-recreate
# Stop aplication
CTRL+C
# then
docker-compose -f docker-compose-dev.yml down
# After build you can run command with this
docker-compose -f docker-compose-dev.yml up
# Or you can hide log with command
docker-compose -f docker-compose-dev.yml up -d
# Create migration in docker container
docker-compose -f docker-compose-dev.yml exec knex-express-template knex migrate:make create_core_users_table --cwd=src
# Run migration in docker container
docker-compose -f docker-compose-dev.yml exec knex-express-template knex migrate:latest --cwd=src
# Create Seed in docker container
docker-compose -f docker-compose-dev.yml exec knex-express-template knex seed:make seed_users --cwd=src
# Run Seed in docker container
docker-compose -f docker-compose-dev.yml exec knex-express-template knex seed:run --cwd=src- Via Make :
# Copy enviroment variables from .env.sample to .env
cp .env.sample .env
# Copy Makefile sesuai environment
cp Makefile.sample Makefile
# Build application
make docker-build
# Stop aplication
CTRL+C
# then
make docker-down
# After build you can run command with this
make docker-start├── coverage/ * all output coverage
├── docker/ * all dockerfile
├── src/ * all source code in here
└── config/ * all configuration file here
| └── database.js * configuration database
└── modules/ * all file modules in here
| └── index.js * register all modules here
└── lang/ * setup language
| └── index.js * register all language here
└── middlewares/ * all middleware file here, for check before next to api
└── repository/ * all file repository for single db or multiple db
| └── monggo * register all monggo
| └── mysql * register all mysql
| └── migrations * all migrations file
| └── seeders * all seeders file
| └── postgresql * register all postgresql
| └── migrations * all migrations file
| └── seeders * all seeders file
└── routes/ * all file route here
| └── index.js * register all route
└── __test__/ * all test case file here
| └── index.js * test apps
└── utils/ * all utils file here
Directory coverage acts as coverage code score this directory automatic generated by jest.
Directory docker acts as container setup this directory is used to setup docker container for local development and production.
This directory has all test case file unit test or integraion test and measurement coverage.
This directory is for create all config like a database, monitoring, aws, gcp, elasticsearch, etc.
This directory for handlers all business logic like a controllers in MVC pattern.
This directory for set language for all message in api set to ['en', 'id', 'jp'].
This directory for all middlewares before access to api/bussines logic.
This directory for handle all use case for database, transaction and file seed or migrations register here.
This directory for register all route api.
This directory for all utils function.
- Guideline:
- Use camelCase for variable name, naming function, load module or other functions
- Use UpperCase for Constant Variable
- Use PascalCase for class name, models
- Use snake_case for file name
- Function name use Verb
- Variable name use Noun
this benchmark is used to measure the performance of your application using apache bench https://httpd.apache.org/docs/2.4/programs/ab.html.
# -c concurency -n number of requests -t time to run
ab -k -c 20 -n 250 "http://localhost:2000/"
#result becnhmark with 50 user and 1000 request
Benchmarking localhost (be patient)
Completed 100 requests
Completed 200 requests
Completed 300 requests
Completed 400 requests
Completed 500 requests
Completed 600 requests
Completed 700 requests
Completed 800 requests
Completed 900 requests
Completed 1000 requests
Finished 1000 requests
Server Software:
Server Hostname: localhost
Server Port: 2000
Document Path: /api/v1/todos
Document Length: 797 bytes
Concurrency Level: 50
Time taken for tests: 5.689 seconds
Complete requests: 1000
Failed requests: 0
Keep-Alive requests: 1000
Total transferred: 1842000 bytes
HTML transferred: 797000 bytes
Requests per second: 175.78 [#/sec] (mean)
Time per request: 284.452 [ms] (mean)
Time per request: 5.689 [ms] (mean, across all concurrent requests)
Transfer rate: 316.19 [Kbytes/sec] received
Connection Times (ms)
min mean[+/-sd] median max
Connect: 0 0 0.4 0 3
Processing: 12 279 52.8 277 470
Waiting: 9 278 52.8 277 470
Total: 12 279 52.8 277 471
Percentage of the requests served within a certain time (ms)
50% 277
66% 298
75% 310
80% 319
90% 348
95% 366
98% 405
99% 414
100% 471 (longest request)