https://github.com/apiqa-io/vue-boilerplate
Boilerplate to quick start vue projects
https://github.com/apiqa-io/vue-boilerplate
docker docker-compose express nginx postgres redis sequelize vue
Last synced: about 1 month ago
JSON representation
Boilerplate to quick start vue projects
- Host: GitHub
- URL: https://github.com/apiqa-io/vue-boilerplate
- Owner: apiqa-io
- Created: 2017-03-18T12:07:30.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-01-15T08:59:42.000Z (almost 8 years ago)
- Last Synced: 2024-04-20T22:37:20.129Z (over 1 year ago)
- Topics: docker, docker-compose, express, nginx, postgres, redis, sequelize, vue
- Language: JavaScript
- Homepage:
- Size: 172 KB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
- favorites-links - Vue Boilerplate
README
Vue-boilerplate
====================
Install
-----
Download:
```bash
$ git clone https://github.com/SYNC-SU/vue-boilerplate.git
```
Pre-install:
1. Change settings in **.env** file
2. Change credentials and add custom data (if you need) in **api/db/migrations/seed.js**
Install:
```bash
$ ./install
```
Scripts:
-------
* **install** - install project.
* **start** - run project. If "ENVIRONMENT" variable in .env file set in "prod", run production version: build frontend and admin apps, and serve it as static minified files.
* **stop [container_name]** - stop container. If container name not provided stop all.
* **restart [container_name]** - restart container. If container name not provided restart all.
* **log [container_name]** - show selected container logs or all logs if container not provided. Accept all docker-compose logs options.
* **yarn [container_name]** - start yarn scripts in container. **container_name** is required.
* **psql and rdb** - CLI for postgres and redis services.
* **migrate \** - create or start migration. Actions: **create \** and **down**. **create** make empty migration in **api/db/migrations** with **name**. **down** runs migration undo. Empty action run all migrations from folder **api/db/migrations**, ordering by filename.
Containers:
--------
### nginx
Nginx web-server. All configs in **nginx** folder.
### postgres
PostgreSQL. Default settings:
```js
host: 'postgres'
port: 5432
username: 'postgres'
password: 'postgres'
dbname: 'boilerplate'
```
### redis
Redis. Default settings:
```js
host: 'redis'
port: 6379
```
### api
API container. Can serve both admin and frontend routes.
Default prefix: **/api**
**express** for REST and **sequelize** for ORM
### frontend
Main interface.
* Vue 2.2.4
* Vue-router 2.2.0
* axios 0.15
Linting with eslint by **standard** rules
### admin
Admin panel.
* Vue 2.2.4
* Vue-router 2.2.0
* axios 0.15
Linting with eslint by **standard** rules
## Defaults:
```js
username: admin@mail.ru
password: admin
```
## License
[MIT](LICENSE)