{"id":20496442,"url":"https://github.com/jkheadley/appy","last_synced_at":"2025-04-07T10:25:29.281Z","repository":{"id":16205932,"uuid":"130616602","full_name":"JKHeadley/appy","owner":"JKHeadley","description":"🚀 A full stack boilerplate web app","archived":false,"fork":false,"pushed_at":"2023-01-12T06:37:06.000Z","size":132469,"stargazers_count":254,"open_issues_count":63,"forks_count":65,"subscribers_count":21,"default_branch":"master","last_synced_at":"2024-04-14T15:26:40.024Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"https://appyapp.io","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JKHeadley.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-22T23:33:55.000Z","updated_at":"2024-03-23T19:13:24.000Z","dependencies_parsed_at":"2023-01-13T20:30:32.868Z","dependency_job_id":null,"html_url":"https://github.com/JKHeadley/appy","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JKHeadley%2Fappy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JKHeadley%2Fappy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JKHeadley%2Fappy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JKHeadley%2Fappy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JKHeadley","download_url":"https://codeload.github.com/JKHeadley/appy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247633577,"owners_count":20970349,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["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"],"created_at":"2024-11-15T18:07:10.843Z","updated_at":"2025-04-07T10:25:29.263Z","avatar_url":"https://github.com/JKHeadley.png","language":"Vue","readme":"\u003cp align=\"center\"\u003e\u003ca href=\"https://appyapp.io\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg width=\"262\" height=\"295\" src=\"https://user-images.githubusercontent.com/12631935/39099920-eaab3d3e-4636-11e8-9955-b53be05e1c13.png\" alt=\"appy logo\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/vuejs/vue\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/vue-2.5.16-brightgreen.svg\" alt=\"vue\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/JKHeadley/appy/blob/master/LICENSE.txt\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/mashape/apistatus.svg\" alt=\"license\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/JKHeadley/appy/releases\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/release/JKHeadley/appy/all.svg\" alt=\"GitHub release\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n**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. \n\n![appy-dashboard](https://user-images.githubusercontent.com/12631935/39155220-f691c77e-4705-11e8-9b83-2129a07c6d35.png)\n\nJust want an API server? Try [appy-backend](https://github.com/JKHeadley/appy-backend)\n\n**Live Demo**: https://appyapp.io/#live_demo\n\n---\n\n\u003cp align=\"center\"\u003e\u003cstrong\u003eappy\u003c/strong\u003e is being sponsored by the following tool; please help to support us by taking a look and signing up to a free trial!\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003ca href=\"https://tracking.gitads.io/?repo=appy\"\u003e\u003cimg src=\"https://images.gitads.io/appy\" alt=\"GitAds\"/\u003e\u003c/a\u003e\u003c/p\u003e\n\n## Requirements\n\nJust [Docker](https://docs.docker.com/install)\n\n**OR**\n\nYou need [Node.js](https://nodejs.org/en/) installed (\u003e=12.14.1) and you'll need [MongoDB](https://docs.mongodb.com/manual/installation/) installed and running.\n\n\n## Getting Started\n\nDownload from GitHub:\n\n```bash\n$ git clone https://github.com/JKHeadley/appy.git\n$ cd appy\n```\n\n## Using Docker\n\n\u003e **NOTE**: Docker commands might take some time on the first build. After the first build they\n\u003e should be relatively quick.\n\nRename `backend/.env-docker-sample` to `backend/.env-docker` and update any secrets or keys as needed (this is not\nrequired, but at minimum providing a valid `IPSTACK_ACCESS_KEY` will allow for proper dashboard\ndata). **Never commit .env-docker to your repo**\n\nAlso, update values in `backend/config/index.js` as needed.\n\nSeed the db with data (only required once):\n\n```bash\n$ sh seed_data.sh\n```\n \nOnce seeding is done, run the app:\n\n```bash\n$ sh run_app.sh\n```\n\nPoint 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:\n\n\u003e **NOTE**: Password for all seed users is `root`.\n\n**\u003ca href=\"http://localhost:3000/login?email=test@user.com\u0026password=root\" target=\"_blank\"\u003eUser\u003c/a\u003e**\n\n**\u003ca href=\"http://localhost:3000/login?email=test@admin.com\u0026password=root\" target=\"_blank\"\u003eAdmin\u003c/a\u003e**\n\n**\u003ca href=\"http://localhost:3000/login?email=test@superadmin.com\u0026password=root\" target=\"_blank\"\u003eSuper Admin\u003c/a\u003e**\n\n\n...that's it, have fun!\n\n## Without Docker\n\nInstall dependencies:\n\n#### Backend\n\n``` bash\n$ cd backend\n$ npm install\n```\n\n#### Frontend\n\n``` bash\n$ cd frontend\n$ npm install\n```\n\n### Backend Configuration\nRename `.env-sample` to `.env` and update any secrets or keys as needed (this is not\nrequired, but at minimum providing a valid `IPSTACK_ACCESS_KEY` will allow for proper dashboard\ndata). **Never commit .env to your repo**\n\nAlso, update values in `backend/config/index.js` as needed.\n\n### First time setup\n**WARNING**: This will clear all data in the MongoDB database defined in ``restHapiConfig.mongo.URI`` (default ``mongodb://localhost/appy``).\n\nTo seed your database with some data, run:\n\n```\n$ npm run seed\n```\n\n\u003e **NOTE**: The password for all seed users is ``root``.\n\n### Running appy\n\n#### Backend\n\n``` bash\n$ npm run start\n```\n\nPoint your browser to http://localhost:8080/ to view the Swagger docs.\n\n#### Frontend\n\n``` bash\n$ npm run start\n```\n\nPoint your browser to http://localhost:3000/ to view the app, or click on one of the test accounts below to login:\n\n**\u003ca href=\"http://localhost:3000/login?email=test@user.com\u0026password=root\" target=\"_blank\"\u003eUser\u003c/a\u003e**\n\n**\u003ca href=\"http://localhost:3000/login?email=test@admin.com\u0026password=root\" target=\"_blank\"\u003eAdmin\u003c/a\u003e**\n\n**\u003ca href=\"http://localhost:3000/login?email=test@superadmin.com\u0026password=root\" target=\"_blank\"\u003eSuper Admin\u003c/a\u003e**\n\n## Temporary Docs\nOfficial 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)\n\nLicense\n-------\nappy is an open source project by [Justin Headley](http://justinheadley.com) that is licensed under [MIT](http://opensource.org/licenses/MIT).\n\n**This project is undergoing a major update. Complete README and docs coming soon.**\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjkheadley%2Fappy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjkheadley%2Fappy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjkheadley%2Fappy/lists"}