---
Random Guilloche Generator
---
## Requirements
- Node.js 10.24.1 (insecure EOL version, provided without warranty)
- Angular CLI
- Nix (for reproducible development environment)
## Development Setup
This project uses Nix for a reproducible development environment.
1. Enter the Nix shell: `nix-shell`
2. Install dependencies: `npm install`
3. Start development: `make start` or `npm run start`
**Disclaimer:** This software is provided without any warranty. Use at your own risk.
## NPM Scripts
| command | description |
|------------------|-----------------------------------------------------------------|
| `npm run start` | start development server on `http://localhost:4200/` |
| `npm run build` | build production application and save to `./dist` |
| `npm run build:library` | build node module and save to `./dist/NlsGuilloche` |
## Development server
After entering the Nix shell, download dependencies with `npm install`.
Run `make start` or `npm run start` for a dev server. Browser opens and navigates automatically to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
## Build
Run `npm run build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
## Author
The author of this software is Michael Czechowski, web developer based in Stuttgart and Berlin, Germany. Only with the support of two very talented web developers, Erik Kimsey and Martin Maga, this software could be realized. We are proud to mention that we can present this software as free software.
## Contributors
- Michael Czechowski ()
- Erik Kimsey
- Martin Maga
## License
Copyright (C) 2018 Michael Czechowski
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
