- Node.js
- npm
- MongoDB
- ImageMagick package (optional, used for rendering projects to single PNG frames or GIF animations)
-
Clone this repository:
git clone https://github.com/andrrrl/velours -
Enter directory:
cd velours -
Install dependencies:
npm install
It will also run an install script, located at./utils/install.jswhich will generate a.envfile usingenv.exampleas a blueprint. If.envfile already exists, the install script will not overwrite it. -
Install optional dependencies:
- Debian/Ubuntu:
apt-get install imagemagick - OSX:
brew install imagemagick
This tool will allow generating GIF animation out of a project
- Debian/Ubuntu:
- MongoDB service needs to be set and running.
- Check your configuration in the
.envfile. - Run Velours with:
npm start - Navigate to localhost:8080
- Define start variables, like colors, dimensions, type of stitch... most of them are very self-explanatory.
- Left click or drag throught the grid to draw stitches.
- Right click or drag to remove stitches.
- The order each stitch is placed will define the order of the GIF animation.
- Some options can be changed while drawing the project
- Run
grunt
It will watch for file changes and compress JS and SASS
- Add option to add rows
- Add option to add columns