appy is a full featured boilerplate web app designed as an end to end solution for mvp development. The frontend is built on Vue.js and utilizes the AdminLTE UI template. The backend implements a hapi server (via rest-hapi) with a MongoDB datastore.
Just want an API server? Try appy-backend
Live Demo: https://appyapp.io/#live_demo
Requirements
Just Docker
OR
You need Node.js installed (>=8.10.0) and you'll need MongoDB installed and running.
Getting Started
Download from GitHub:
$ git clone https://github.com/JKHeadley/appy.git
$ cd appy
Using Docker
NOTE: Docker commands might take some time on the first build. After the first build they should be relatively quick.
First seed the db with data (only required once):
$ sh seed_data.sh
Once seeding is done, run the app:
$ sh run_app.sh
Point your browser to http://localhost:3000/ to view the app, http://localhost:8080/ to view the swagger API docs, or click on one of the test accounts below to login:
NOTE: Password for all seed users is
root
.
...that's it, have fun!
Without Docker
Install dependencies:
Backend
$ cd backend
$ npm install
Frontend
$ cd frontend
$ npm install
Backend Configuration
Rename .env-sample
to .env
. Update values as needed. Never commit .env to your repo
Also, update values in config.js
as needed.
First time setup
WARNING: This will clear all data in the MongoDB database defined in restHapiConfig.mongo.URI
(default mongodb://localhost/appy
).
To seed your database with some data, run:
$ npm run seed
NOTE: The password for all seed users is
root
.
Running appy
Backend
$ npm run start
Point your browser to http://localhost:8080/ to view the Swagger docs.
Frontend
$ npm run start
Point your browser to http://localhost:3000/ to view the app, or click on one of the test accounts below to login:
Temporary Docs
Official docs for appy are coming soon, but for now you can find some information in the appy-backend wiki
License
appy is an open source project by Justin Headley that is licensed under MIT.
This project is undergoing a major update. Complete README and docs coming soon.