GitHub Custom Instructions Compiler

Library of Custom Instructions for GitHub Copilot users.

🔗 https://movinglive.github.io/custom-instructions-compiler/

Technologies Used

• React with TypeScript.
• Vite for bundling.
• Tailwind CSS for styling.
• Octokit for interacting with the GitHub API.

Installation

Install dependencies using npm:

npm install

Usage

To run the application in development mode:

npm run dev

To build the application for production:

npm run build

To preview the production build:

npm run preview

Configuration

• The application's entry point is index.html, which loads the script src/main.tsx.
• Vite configuration is located in vite.config.ts.
• TypeScript configurations are defined in tsconfig.json, tsconfig.app.json, and tsconfig.node.json.
• ESLint configuration is available in eslint.config.js.
• Styling is managed using Tailwind CSS, configured in tailwind.config.js and postcss.config.js.

Deployment

Continuous deployment is set up with GitHub Actions in the file .github/workflows/deploy.yml. The application is deployed to GitHub Pages.

License

This project is licensed under the GNU GPLv3 license. See the LICENSE file for more details.