In order to run the project from a container we need node>=14, npm>=7 and docker>=20 installed on our development machines or
use one of the listed cloud providers we support:
To install the application:
npm ciTo start a local copy of the app on port 3000:
npm startFor running the test suite, use the following command. Since the tests run in watch mode by default, some users may encounter errors about too many files being open. In this case, it may be beneficial to install watchman.
npm testYou can request a coverage report by running the following command:
npm run test:coverageA development preview can also be run from docker:
docker build -t open-sauced-hot .
docker run -p 8080:80 open-sauced-hotAlternatively you can pull the production container and skip all builds:
docker run -dit -p 8080:80 ghcr.io/open-sauced/hotTo check the code and styles quality, use the following command:
npm run lintThis will also display during development, but not break on errors.
To fix the linting errors, use the following command:
npm run formatA production deployment is a complete build of the project, including the build of the static assets.
npm run buildWe encourage you to contribute to Open Sauced! Please check out the Contributing guide for guidelines about how to proceed.
We have a commit utility called @open-sauced/conventional-commit that helps you write your commits in a way that is easy to understand and process by others.
It is generally integrated as an npm script but you can run it with npx as well:
npm run pushFor any other npm based project or dotnpmrc defaulting to --yes:
npx -y @open-sauced/conventional-commitGot Questions? Join the conversation in our Discord.
Find Open Sauced videos and release overviews on our YouTube Channel.
MIT © Open Sauced