]> git.parisson.com Git - mezzo.git/commitdiff
Update doc, add gulp port
authorGuillaume Pellerin <guillaume.pellerin@ircam.fr>
Thu, 8 Dec 2016 10:48:02 +0000 (11:48 +0100)
committerGuillaume Pellerin <guillaume.pellerin@ircam.fr>
Thu, 8 Dec 2016 10:48:02 +0000 (11:48 +0100)
README.rst
doc/src/development.rst
doc/src/overview.rst
env/dev.yml

index ffb2079333b4691a9f8cc917406ca24ba21cb486..3bd4ef9adbc407f72f176d331d5b2ceeb7064abc 100644 (file)
@@ -2,15 +2,25 @@
 Mezzanine-organization
 ======================
 
-This application is a CMS for organizations with workflows
+Mezzanine-organization is a complete CMS for organizations with complex workflows
 
 It is based on Mezzanine_ and Django_.
 
 Use cases
 ==========
 
-...
+In fact any organization web site that needs a dedicated customable backend...
 
+Features
+========
+
+- Page, news and event management
+- Smart media management (video, audio, etc..)
+- Project data management including demo repositories
+- Activity management of person per department
+- Job candidancy forms
+- Full translation models
+- Fully dockerized for easy setup
 
 .. _Django : https://www.djangoproject.com/
 .. _Mezzanine : http://mezzanine.jupo.org/
@@ -204,14 +214,14 @@ Prod
 Development
 ===========
 
-Start in dev mode
-+++++++++++++++++
+Dev mode
++++++++++
 
 For a development environment setup::
 
     docker-compose -f docker-compose.yml -f env/dev.yml up
 
-Then browse the app at http://localhost:9020/
+This will launch the django development server. Then browse the app at http://localhost:9020/
 
 On MacOS or Windows, we need to replace 'localhost' by the IP given by the docker terminal.
 
@@ -237,13 +247,14 @@ Accessing the app container shell::
 Front
 +++++
 
-1. Installing gulp dependencies::
+The styles are written in SASS in app/static and the builder uses Gulp.
+All the builing tools are included in the app container so that you can build the front in one command::
 
-    See previous section: "Compile static files".
+    bin/build_font.sh
 
-2. Run gulp::
+To start the gulp server to get dynamic builing::
 
-    gulp
+    docker-compose run app gulp serve
 
 Gulp will launch BrowserSync. BrowserSync is a middleware that expose the website on port 3000.
 Any change on CSS or JS files will trigger the build system and reload the browser.
index 1f54d012bb4d41a635ffaad932044f95c52776cb..2ccbc0e13cd63231d7473a5cc3386af77beb372d 100644 (file)
@@ -2,14 +2,14 @@
 Development
 ===========
 
-Start in dev mode
-+++++++++++++++++
+Dev mode
++++++++++
 
 For a development environment setup::
 
     docker-compose -f docker-compose.yml -f env/dev.yml up
 
-Then browse the app at http://localhost:9020/
+This will launch the django development server. Then browse the app at http://localhost:9020/
 
 On MacOS or Windows, we need to replace 'localhost' by the IP given by the docker terminal.
 
@@ -35,13 +35,14 @@ Accessing the app container shell::
 Front
 +++++
 
-1. Installing gulp dependencies::
+The styles are written in SASS in app/static and the builder uses Gulp.
+All the builing tools are included in the app container so that you can build the front in one command::
 
-    See previous section: "Compile static files".
+    bin/build_font.sh
 
-2. Run gulp::
+To start the gulp server to get dynamic builing::
 
-    gulp
+    docker-compose run app gulp serve
 
 Gulp will launch BrowserSync. BrowserSync is a middleware that expose the website on port 3000.
 Any change on CSS or JS files will trigger the build system and reload the browser.
index 6fab30472f0c5f2c11f7cf2c5b9907c1ec65af0d..9fa69c6bc0295d3c81d4d6454d890b4f9f60f581 100644 (file)
@@ -2,15 +2,25 @@
 Mezzanine-organization
 ======================
 
-This application is a CMS for organizations with workflows
+Mezzanine-organization is a complete CMS for organizations with complex workflows
 
 It is based on Mezzanine_ and Django_.
 
 Use cases
 ==========
 
-...
+In fact any organization web site that needs a dedicated customable backend...
 
+Features
+========
+
+- Page, news and event management
+- Smart media management (video, audio, etc..)
+- Project data management including demo repositories
+- Activity management of person per department
+- Job candidancy forms
+- Full translation models
+- Fully dockerized for easy setup
 
 .. _Django : https://www.djangoproject.com/
 .. _Mezzanine : http://mezzanine.jupo.org/
index 4eedc10cce59f27a009fefb2a1d14b424362ab48..0af15322f84640ae1d546d52d6c5fea92e99ae5a 100644 (file)
@@ -25,5 +25,6 @@ app:
     - ./app/:/srv/app
   ports:
     - "9020:8000"
+    - "3000:3000"
   environment:
     - DEBUG=True