diff --git a/README.md b/README.md new file mode 100644 index 0000000..eaf278f --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Project Name + +Powered by Craft CMS + +## Software requirements +- node 8 +- npm 6 +- php >= 7.1 +- mysql 5.7 +- composer + +## Setup instructions + +- Copy `.env.example` to `.env` + +- Install php dependencies + + $ composer install + +- Create mysql database and import a SQL dump + - You can get a SQL dump from prod by logging into the admin and going to Utilities > Backup Database + +- Fill in the database credentials in the `.env` file + +- Install frontend dependencies + + $ npm i + +- Build frontend dependencies + + $ npm run build + +- Startup a php server pointing to the web folder + + $ php -S localhost:8000 -t web