Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/empeje/last-mile-delivery
An (sample) API Implementation of last mile delivery written in Node.js
https://github.com/empeje/last-mile-delivery
api last-mile-deliveries logistics made-in-indonesia
Last synced: about 1 month ago
JSON representation
An (sample) API Implementation of last mile delivery written in Node.js
- Host: GitHub
- URL: https://github.com/empeje/last-mile-delivery
- Owner: empeje
- License: mit
- Archived: true
- Created: 2019-11-07T10:24:22.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T01:37:32.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T21:42:43.781Z (4 months ago)
- Topics: api, last-mile-deliveries, logistics, made-in-indonesia
- Language: JavaScript
- Homepage: https://empeje.github.io/last-mile-delivery/
- Size: 1.5 MB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-made-by-indonesian - Last Mile Delivery API - `An (sample) API Implementation of last mile delivery written in Node.js` *by [mpj](https://github.com/empeje)* (L)
- made-in-indonesia - Last Mile Delivery API - `An (sample) API Implementation of last mile delivery written in Node.js` *by [mpj](https://github.com/empeje)* (L)
README
# Last Mile Delivery API
[](https://travis-ci.com/empeje/last-mile-delivery)
[](https://www.codementor.io/amappuji?utm_source=github&utm_medium=button&utm_term=amappuji&utm_campaign=github)
[](https://github.com/made-in-indonesia/made-in-indonesia)
## Live Preview
You can use [https://last-mile-delivery.herokuapp.com/][heroku_instance] for Live Preview, this instance running on free Dyno hours, so please expect error when our database records limit or hours limit reached.
## How to run from source
- Copy `.env.example` to `.env`, this `.env` file will be used in local for test, and development purposes. For production .env will not be used and system environment variables will be used.
```bash
$ cp .env.example .env
```
- Edit `.env` file as needed, here are the most important config to change
```bash
PORT=8080 # this is the port we want to expose, if you change this, please look at the `docker-compose.yml` as well
GOOGLE_MAPS_API_KEY= # this is the Google Maps API Key
```
- You can run the following script which run our [docker-compose](./docker-compose.yml) setup in detached mode and then attached to the logs so that you'll not stop the app when you detached from the log.
```bash
$ ./start.sh
```
## How to run from packaged Docker image
We've prebuild Docker image stored as [mappuji/last-mile-delivery][hub_registry] in DockerHub. Where you can run it like this
```bash
$ docker-compose -f docker-compose.yml -f docker-compose.prod.yml
```
This run exactly the same thing with running it from source except we use prebuilt image that already pushed to DockerHub.
## Design Documentation
The architectural design of the system can be open at [empeje.github.io/last-mile-delivery][design_docs].
### Maintaining Documentation
1. You can maintain the documentation by adding [mermaid-js][mermaid] diagram DSL in the `docs/index.html`
2. Upload the GitHub pages using
```bash
$ yarn deploy:docs
```
## Development Infrastructure Checklist
| Metrics | Notes | Implemented |
| ------------------- | ------------------------------------------------------------- | ----------- |
| Code Quality | Standardization and static check using ESLint | ✓ Yes |
| Unit Testing | Unit level testing for models | ✓ Yes |
| Integration Testing | Integration level testing e.g. API | ✓ Yes |
| End-to-end Testing | Blackbox testing, running real service with real ext. service | NA |
| Auto-reload in Dev | File watcher that auto reload whenever changes occurs | ✓ Yes |
| Continuous Int. | Continuous integration using Travis CI for public repository | ✓ Yes |
## Production Checklist
| Metrics | Notes | Implemented |
| ------------------- | ---------------------------------------------------------------- | ----------- |
| Codebase | One codebase tracked in revision control, many deploys | ✓ Yes |
| Dependencies | Explicitly declare and isolate dependencies | ✓ Yes |
| Config | Store config in the environment | ✓ Yes |
| Backing services | Treat backing services as attached resources | ✓ Yes |
| Build, release, run | Strictly separate build and run stages | ✓ Yes |
| Processes | Execute the app as one or more stateless processes | ✓ Yes |
| Port binding | Export services via port binding | ✓ Yes |
| Concurrency | Scale out via the process model | ✓ Yes |
| Disposability | Maximize robustness with fast startup and graceful shutdown | ✓ Yes |
| Dev/prod parity | Keep development, staging, and production as similar as possible | ✓ Yes |
| Logs | Treat logs as event streams | ✓ Yes |
| Admin processes | Run admin/management tasks as one-off processes | NA |
## Deployment Using Heroku Docker
### Update your Heroku CLI
This meant to update your Heroku CLI to support setting up via heroku manifest setup
```bash
$ heroku update beta
$ heroku plugins:install @heroku-cli/plugin-manifest
```
### Create your Heroku app
```bash
$ heroku create your-app-name --manifest
```
### Create Clear DB add-ons
```bash
$ heroku addons:create cleardb:ignite
# command below will return
# CLEARDB_DATABASE_URL: mysql://:@/?reconnect=true
$ heroku config | grep CLEARDB_DATABASE_URL # copy the information to config
# Set database configuration
heroku config:set PORT=8080
heroku config:set LOG_FORMAT=simple
heroku config:set SQL_DATABASE=YOUR_HEROKU_DATABASE
heroku config:set SQL_HOST=YOUR_HEROKU_DATABASE_HOST
heroku config:set SQL_PASSWORD=YOUR_HEROKU_DATABASE_PASSWORD
heroku config:set SQL_USERNAME=YOUR_HEROKU_DATABASE_USERNAME
heroku config:set SQL_DIALECT=mysql
heroku config:set SQL_OPERATOR_ALIASES=false
heroku config:set SQL_SEEDER_STORAGE=sequelize
heroku config:set SQL_SEEDER_STORAGE_TABLE_NAME=SequelizeData
heroku config:set GOOGLE_MAPS_API_KEY=YOUR_GOOGLE_MAPS_API_KEY
```
### Deploy your app
```bash
$ git push heroku master
```
[design_docs]: https://empeje.github.io/last-mile-delivery/
[mermaid]: https://mermaidjs.github.io/#/
[hub_registry]: https://hub.docker.com/repository/docker/mappuji/last-mile-delivery
[heroku_instance]: https://last-mile-delivery.herokuapp.com/