๐
Open Sauced Vite Typescript Template Test
๐
The path to your next Open Source contribution
๐
Prerequisites
In order to run the project we need the following software binaries installed on our development machines:
node>=16.7.0npm>=8.0.0docker>=20.10.12supabase>=0.18.0
๐ฅ๏ธ
Local development
To install the application:
npm ci
To start a local copy of the app on port 3000:
npm start
๐งช
Test
For 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 test
You can request a coverage report by running the following command:
npm run test:coverage
๐ฆ
Docker builds
A development preview can also be run from docker:
docker build -t open-sauced-template .
docker run -p 8080:80 open-sauced-template
Alternatively you can pull the production container and skip all builds:
docker run -dit -p 8080:80 ghcr.io/open-sauced/open-sauced
๐จ
Code linting
To check the code and styles quality, use the following command:
npm run lint
This will also display during development, but not break on errors.
To fix the linting errors, use the following command:
npm run format
๐
Production deployment
A production deployment is a complete build of the project, including the build of the static assets.
npm run build
You can analyze the build by running the following command:
npm run build:analyze
๐ญ
Offline asset optimization
We also have a script for updating .svg files used in the project, you only need to run this if you add new assets:
npm run build:svgo
And one for .png and .jpg files:
npm run build:squoosh
๐ง
Development debugging
Thanks to antfu/vite-plugin-inpesct we can always inspect the bundles in development by navigating to localhost:3000/__inspect/ in your browser.
๐ค
Contributing
We encourage you to contribute to Open Sauced! Please check out the Contributing guide for guidelines about how to proceed.
๐
Community
Got Questions? Join the conversation in our Discord.
Find Open Sauced videos and release overviews on our YouTube Channel.
๐ฆ
Repository Visualization
โ๏ธ
LICENSE
MIT ยฉ Open Sauced
29 May 3, 2022
10 Aug 2, 2022
81 Dec 31, 2022
3 Mar 26, 2022
6 Aug 1, 2022
10 Oct 7, 2022
6 Jun 25, 2022
8 Nov 11, 2022
62 Dec 22, 2022
9 Jul 16, 2022