Vocabustudy is a simplistic tool for studying Vocabulary. Vocabustudy is created by students, for students.

No Ads - Always Free - No Account Needed - Feedback is Welcome!

Follow these steps to run Vocabustudy locally:

1. Clone the repo locally (I recommend using the Github CLI if you're brand new to Git) gh repo clone For-0/vocabustudy
2. Install NPM packages: npm install (Make sure you have Node.JS installed)
3. Install firebase-tools globally: npm install -g firebase-tools
4. Start Vite: npm run dev
5. Start the Firebase Emulator (Make sure you have Java installed and on your path): npm run emulator

Most steps of the deployment process are automated:

1. Bump the version with npm version. This will also create a commit and a tag
2. Push version commit/tag with git push --follow-tags
3. Create a new release on the new tag with gh release creator or the UI.
4. Building and deployment to Cloudflare Pages are done automatically once the release is created by GH Actions
5. If you updated the Firestore Rules or Indices, update thos manually with firebase-tools
6. The release notes will be pushed to the Discord server