OPEN SOURCE
Contribute to veyra.
veyra is open source and contributions are welcome. Follow the steps below to set up the project locally and start making changes.
LOCAL SETUP
Set up veyra locally.
Follow these steps to get a local development environment running.
Fork the repository
Create your own fork of the veyra repository on GitHub.
Clone your fork
Clone the repository to your local machine and move into the project directory.
git clone https://github.com/YOUR_USERNAME/veyra.git
cd veyraInstall dependencies
Install the project dependencies before starting development.
npm installConfigure environment variables
Create a .env.local file and add the required API key.
GEMINI_API_KEY=your_gemini_api_keyNever commit your .env.local file or expose API keys in your changes.
Start the development server
Run veyra locally and make sure everything is working before making changes.
npm run devDEVELOPMENT
Make your changes.
Keep changes focused and make sure the project still works before opening a pull request.
git checkout -b feature/your-feature
# make your changes
git add .
git commit -m "feat: describe your change"
git push origin feature/your-featurePULL REQUESTS
Keep pull requests clean.
Explain what you changed.
Explain why the change was needed.
Test your changes locally.
Keep the pull request focused.
Do not include API keys or secrets.
Make sure existing functionality still works.
COMMITS
Use clear commit messages.
Use a simple commit type so changes are easy to understand.
featAdd a new feature
fixFix a bug
docsUpdate documentation
styleUpdate UI or styling
refactorImprove existing code
choreProject maintenance
Ready to contribute?
Build something useful with veyra.
Fork the repository, make your changes, and open a pull request.