Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jkheadley/appy
🚀 A full stack boilerplate web app
https://github.com/jkheadley/appy
admin admin-dashboard adminlte authorization backend boilerplate boilerplate-web chat frontend full-stack hapi nodejs permissions social-login user-management vue vue-admin vue-app vue-boilerplate webapp
Last synced: about 2 hours ago
JSON representation
🚀 A full stack boilerplate web app
- Host: GitHub
- URL: https://github.com/jkheadley/appy
- Owner: JKHeadley
- License: mit
- Created: 2018-04-22T23:33:55.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-12T06:37:06.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T15:26:40.024Z (7 months ago)
- Topics: admin, admin-dashboard, adminlte, authorization, backend, boilerplate, boilerplate-web, chat, frontend, full-stack, hapi, nodejs, permissions, social-login, user-management, vue, vue-admin, vue-app, vue-boilerplate, webapp
- Language: Vue
- Homepage: https://appyapp.io
- Size: 126 MB
- Stars: 254
- Watchers: 21
- Forks: 65
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
**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](https://vuejs.org) and utilizes the [AdminLTE](https://adminlte.io) UI template. The [backend](https://github.com/JKHeadley/appy/tree/master/backend) implements a hapi server (via [rest-hapi](https://github.com/JKHeadley/rest-hapi)) with a MongoDB datastore.
Just want an API server? Try [appy-backend](https://github.com/JKHeadley/appy-backend)
**Live Demo**: https://appyapp.io/#live_demo
---
appy is being sponsored by the following tool; please help to support us by taking a look and signing up to a free trial!
## Requirements
Just [Docker](https://docs.docker.com/install)
**OR**
You need [Node.js](https://nodejs.org/en/) installed (>=12.14.1) and you'll need [MongoDB](https://docs.mongodb.com/manual/installation/) installed and running.
## Getting Started
Download from GitHub:
```bash
$ 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):
```bash
$ sh seed_data.sh
```
Once seeding is done, run the app:
```bash
$ 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`.
**User**
**Admin**
**Super Admin**
...that's it, have fun!
## Without Docker
Install dependencies:
#### Backend
``` bash
$ cd backend
$ npm install
```
#### Frontend
``` bash
$ 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
``` bash
$ npm run start
```
Point your browser to http://localhost:8080/ to view the Swagger docs.
#### Frontend
``` bash
$ 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:
**User**
**Admin**
**Super Admin**
## Temporary Docs
Official docs for appy are coming soon, but for now you can find some information in the [appy-backend wiki](https://github.com/JKHeadley/appy-backend/wiki)
License
-------
appy is an open source project by [Justin Headley](http://justinheadley.com) that is licensed under [MIT](http://opensource.org/licenses/MIT).
**This project is undergoing a major update. Complete README and docs coming soon.**