Home

Awesome

<p align="center"><a href="https://appyapp.io" target="_blank" rel="noopener noreferrer"><img width="262" height="295" src="https://user-images.githubusercontent.com/12631935/39099920-eaab3d3e-4636-11e8-9955-b53be05e1c13.png" alt="appy logo"></a></p> <p align="center"> <a href="https://github.com/vuejs/vue"> <img src="https://img.shields.io/badge/vue-2.5.16-brightgreen.svg" alt="vue"> </a> <a href="https://github.com/JKHeadley/appy/blob/master/LICENSE.txt"> <img src="https://img.shields.io/github/license/mashape/apistatus.svg" alt="license"> </a> <a href="https://github.com/JKHeadley/appy/releases"> <img src="https://img.shields.io/github/release/JKHeadley/appy/all.svg" alt="GitHub release"> </a> </p>

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.

appy-dashboard

Just want an API server? Try appy-backend

Live Demo: https://appyapp.io/#live_demo

<p align="center"><strong>appy</strong> is being sponsored by the following tool; please help to support us by taking a look and signing up to a free trial!</p> <p align="center"><a href="https://tracking.gitads.io/?repo=appy"><img src="https://images.gitads.io/appy" alt="GitAds"/></a></p>

Requirements

Just Docker

OR

You need Node.js installed (>=12.14.1) 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.

Rename backend/.env-docker-sample to backend/.env-docker and update any secrets or keys as needed (this is not required, but at minimum providing a valid IPSTACK_ACCESS_KEY will allow for proper dashboard data). Never commit .env-docker to your repo

Also, update values in backend/config/index.js as needed.

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.

<a href="http://localhost:3000/login?email=test@user.com&password=root" target="_blank">User</a>

<a href="http://localhost:3000/login?email=test@admin.com&password=root" target="_blank">Admin</a>

<a href="http://localhost:3000/login?email=test@superadmin.com&password=root" target="_blank">Super Admin</a>

...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 and update any secrets or keys as needed (this is not required, but at minimum providing a valid IPSTACK_ACCESS_KEY will allow for proper dashboard data). Never commit .env to your repo

Also, update values in backend/config/index.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:

<a href="http://localhost:3000/login?email=test@user.com&password=root" target="_blank">User</a>

<a href="http://localhost:3000/login?email=test@admin.com&password=root" target="_blank">Admin</a>

<a href="http://localhost:3000/login?email=test@superadmin.com&password=root" target="_blank">Super Admin</a>

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.