kaldonia/sharepicgenerator

Sharepicgenerator

Sharepicgenerator with Docker and Grunt.

Installation

1. Clone this repo with git clone ...

2. Install dependencies with docker-compose run grunt sh -c 'npm install'

3. Bring up the project with docker-compose up -d

4. Create config.json-File from config-sample.json

5. Run make compile to compile css an js. (Do this after very branch-checkout, or invoke file-watcher by editing a sass- or js-file)

There is also a Makefile. You can use make up and make install.

Usage

Bring up the project (see above) and head to http://127.0.0.1:9000. The portnumber is defined in the .env-File.

Projectstructure

code

Every code goes here.

code/dist

This directory is to be deployed.

code/build

Here reside the Javascript and SCSS-files. They are compiled by Grunt.

code/node_modules

Are installed by nmp. Nothing to do here. Will not be commited. Use npm install to create folder and its content.

docker

The Dockerfiles are here. They are referred to from docker-compose.yml.

fonts

All font-files are linked into to webserver-container, so that inkscape can use them. Handle webfonts in code/dist/fonts independently from that.

Code

assets and fonts

Pictures, logos, webfonts, etc. can be stored here

assets/css and assets/js

Compiled files. Use build-directory to change code.

tmp

Uploaded files are here as well as the sharepic. Files are deleted regularly.

persistent

Templates go here. Opposite to /tmp, directory will not be emtied automatically.

vendor

SVG.js, jQuery etc. are here. They are placed manually, not by npm.