💬 💬 💬 promptspinner.com

The Prompt Spinner is an application designed to help you quickly generate prompts for any defined creative activity or endeavor.

developing

quick start for mac

# download the workspace
git clone --single-branch --depth 1 https://github.com/daniellacosse-code/prompt-spinner.git
cd prompt-spinner

# this will install several dependencies. you can run it again later if you need to
yarn .setup

# run this if you use vscode
yarn .setup:vscode

# check that the project builds
yarn build

# start developing
yarn .watch

debugging the development process

When things aren't working, make sure to try the following first:

1. yarn .reset
2. Run Developer: Reload Window from the vscode command palette

If that doesn't fix the problem, you may need to create an issue.

yarn commands

naming conventions

• yarn <command>: commands that are run on CI environments, like test build and lint
• yarn .<command>: tools for the developer, like .setup .watch .reset and .commit

This mirrors the .<file> naming convention for dotfiles

• yarn @<command>: package to run the command in:

# run the build command in the nuxt package
yarn @nuxt build

This mirrors the @<scope> naming convention for packages

reference

command	description
yarn .clean	remove all dependencies and caches
yarn .commit	commit changes using commitizen and push the result
yarn .open	open all development websites in your browserl
yarn .reset	reset the project
yarn .setup	install dependencies and setup the project
yarn .setup:vscode	configure vscode and install extensions
yarn .watch	start the development server
yarn .watch:build	reubild the project when changes are made
yarn .watch:lint	lint the project when changes are made
yarn .watch:test	run the test suite when changes are made
yarn .watch:types	check typescript types when changes are made
yarn .reset	reset the entire project
yarn @nuxt	run a command in the nuxt package
yarn @spinner-engine	run a command in the spinner-engine package
yarn build	compile the entire project
yarn build:docs	compile the documentation
yarn build:source	compile the source code
yarn lint	lint the project
yarn smoke	automated check that confirms the site loads
yarn test	run the test suite
yarn types	check typescript types