diff --git a/README.md b/README.md index 2ac33ef..847634d 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ -#InertiaJS + Vue3 + Tailwind CSS + AdonisJS Bolierplate \ No newline at end of file +# InertiaJS + Vue3 + Tailwind CSS 2.0 + AdonisJS 5 Bolierplate + +## Installation + +Install NPM dependencies : +```bash +npm ci +``` + +### Compile Assets + +Build assets : +```bash +node ace mix:build +``` +Build assets and watch for file changes : +```bash +node ace mix:watch +``` +Build assets for production : +```bash +node ace mix:build --production +``` +### Run server + +Run adonis server : +```bash +node ace serve --watch +``` \ No newline at end of file