whoadood / osc-pp

Open Stick Community - product page
https://osc-pp.netlify.app/
MIT License
0 stars 1 forks source link

Open Stick Community

Open Stick Community - Product Page

This is a product landing page for the open stick community. It is meant to be a central location for all related links to the GP2040-CE firmware and partners.

šŸŖ„ Creators

For creators looking to be showcased as builders using GP2040-CE, you will need to create a fork of this repo. Once forked you will want to navigate to the vendors.ts file.

/
|__utils/
   |__vendors.ts

From there you can click on the edit file icon in the upper right hand corner. Once editing follow vendor template to add your information to the hardware list.

If you wish to include an image of your project and its not hosted on a CDN, you will need to also include the image file in the projects folder and update your hardware information with /<YOUR_FILE_NAME>.<YOUR_FILE_EXTENSION>.

/
|__public/
  |__projects/
     |__<YOUR_FILE_NAME>.<YOUR_FILE_EXTENSION>

šŸ§ž Commands

All commands are run from the root of the project, from a terminal:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:3000
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro preview
npm run astro --help Get help using the Astro CLI