README.md
changeset 0 800e4a6ab128
child 2 8bfef8029c17
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Tue Apr 23 15:50:12 2019 +0200
@@ -0,0 +1,106 @@
+# Recherchecontributive.org Website
+
+This project is the website for recherchecontributive.org.
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+
+### Prerequisites
+
+What things you need to install the software and how to install them
+
+  - docker
+  - docker-compose
+  - A code editor
+
+
+### Installing
+
+Launch the project
+
+```
+$ docker-compose up
+```
+or
+```
+$ docker-compose up -d
+```
+
+import data.
+
+```
+$ docker-compose exec -T wp /var/www/html/vendor/bin/wp --allow-root db import - < /path/to/recherchecontributive_dbase.sql
+```
+
+Replace strings in database:
+
+```
+docker-compose exec wp /var/www/html/vendor/bin/wp --allow-root search-replace https://recherchecontributive.org http://localhost:8080
+```
+
+Import media files:
+```
+$ tar -C src/web/app/ zxf /path/to/recherchecontributive_media.tar.gz 
+```
+
+Navigate to http://localhost:8080.
+
+## Deployment
+
+TODO...
+
+## Built With
+
+* [Wordpress](https://wordpress.org/) - The CMS used
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://www.iri.centrepompidou.fr/dev/hg/recherchecontributive/tags). 
+
+## Authors
+
+* **Yves-Marie Haussonne** - *Initial work*
+
+## License
+
+This project is licensed under the CecCill License - see the [LICENSE.md](LICENSE.md) file for details
+
+## Acknowledgments
+
+* Hat tip to anyone whose code was used
+* Wordpress: https://wordpress.org/
+* Bedrock: https://roots.io/bedrock
+* Docker for loacl wordpress development: https://urre.me/writings/docker-for-local-wordpress-development/
+
+
+## Data management
+
+
+### Export database
+```
+$ docker-compose exec wp /var/www/html/vendor/bin/wp --allow-root db export --add-drop-table - > recherchecontributive_dbase_2019-04-19.sql
+```
+
+### Export media
+```
+$ tar zcf recherchecontributive_media_2019-04-19.tar.gz -C src/web/app/ uploads
+```
+
+### Import database
+
+```
+$ docker-compose exec -T wp /var/www/html/vendor/bin/wp --allow-root db import - < recherchecontributive_dbase_2019-04-19.sql
+```
+
+If needed do a search replace after this to update the site urls:
+
+```
+$ docker-compose exec wp /var/www/html/vendor/bin/wp --allow-root search-replace https://recherchecontributive.org http://localhost:8080
+```
+
+Or change the administration password
+```
+$ docker-compose exec -T wp /var/www/html/vendor/bin/wp --allow-root user update admin --prompt=user_pass
+```
+