Skip to content

Commit 6643b60

Browse files
committed
add script as example how to set up a dev environment
1 parent 10373eb commit 6643b60

File tree

2 files changed

+34
-1
lines changed

2 files changed

+34
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ To reset the admin password run
105105

106106
To use this docker setup for development of phpList, phpList themes or phpList plugins visit https://resources.phplist.com/develop/docker
107107

108+
Here is a [quick script](https://github.com/phpList/phplist-docker/blob/master/setup.sh) to show how to set up a development environment.
109+
108110

109111
## database
110112

@@ -118,4 +120,4 @@ and then restart phpList-docker
118120

119121
* To load your own data into the database, take a DB snapshot, eg "phplist.sql.gz" and run
120122

121-
```gunzip -c phplist.sql.gz | docker exec phplist_dbhost mysql mysql -u[DBUSER] -p[DBPASS] [DBNAME]```
123+
```gunzip -c phplist.sql.gz | docker exec -i phplist_dbhost mysql mysql -u[DBUSER] -p[DBPASS] [DBNAME]```

setup.sh

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
#!/usr/bin/env bash
2+
3+
## This script will create a folder called "phplist-dev"
4+
## and check out various repositories in there.
5+
## after that it will initialise the Docker setup and start it
6+
##
7+
8+
rm -rf phplist-dev
9+
mkdir phplist-dev
10+
cd phplist-dev
11+
git clone https://github.com/phplist/phplist3
12+
mkdir phpListPlugins
13+
mkdir phpListThemes
14+
15+
cd phpListThemes
16+
git clone https://github.com/phpList/phplist-ui-bootlist.git
17+
cd ..
18+
cd phpListPlugins
19+
git clone https://github.com/phpList/phplist-plugin-subjectLinePlaceholdersPlugin.git
20+
21+
## add here any other plugins that you want to check out
22+
23+
cd ..
24+
git clone https://github.com/phpList/phplist-docker.git
25+
cp phplist-docker/.env-dist phplist-docker/.env
26+
echo THEME_DEV_PATH=$(pwd)/phpListThemes >> phplist-docker/.env
27+
echo CODE_PATH=$(pwd)/phplist3/public_html/ >> phplist-docker/.env
28+
echo PLUGIN_DEV_PATH=$(pwd)/phpListPlugins >> phplist-docker/.env
29+
cd phplist-docker
30+
docker-compose -f phplist-dev.yml up
31+

0 commit comments

Comments
 (0)