ACNLPatternTool
An application to edit Animal Crossing pattern designs.
Installation
At the root of the project directory:
# submodule setup
git submodule update --init --recursive
cd zxing-js-library
yarn # need this to bypass sharp missing binaries
# ^ if yarn throws an error, ignore it. it's sharp's maintainer's fault
cd ..
# main repo setup
npm install
npm run build:submodule # build the submodule
# submodule ALWAYS needs to be rebuilt if it changes
# e.g. switching branches, making updates to the submodule, etc.
Available Scripts
npm run dev
Runs the application in development mode. Automatically reloads with changes. Open https://localhost:3000 to view it in the browser. This command does not build the submodule. Remember to build or even rebuild the submodule if it changes.
npm run build -- <options>
Builds the submodules, app, and then outputs to a build
directory at the
repository root. Can build the the project in development mode or production
mode. By default builds in the mode specified by the .env
, but can otherwise
override with a command line option. Use --help
option to view options.
npm run build:app -- <options>
Builds the app and outputs to a build
directory at the repository root. Can
build the the project in development mode or production mode. By default builds
in the mode specified by the .env
, but can otherwise override with a command
line option. Use --help
option to view options.
npm run build:submodule
Builds the submodules and outputs to a build
directory at the repository
root. Can build the the project in development mode or production mode. By
default builds in the mode specified by the .env
, but can otherwise override
with a command line option.
Any time the submodule changes, this command needs to be rerun.
Parallel development bewteen the main project and the submodule can be made
easier by using the npm run watch
directly from the zxing directory.
npm run clean
Cleans the submodule and app build directories. Recursively removes files located in the build directories.
npm run clean:app
Cleans the app build directory. Recursively removes files located in the build directory.
npm run clean:submodule
Cleans the submodule build directory. Recursively removes files located in the build directory.