A mobile-first Visual Bible Study web app built for Dr. H. Wayne House's study Bible.
Frontend:
Backend:
- Vercel SSR
- Firebase Authentication
- Firebase Cloud Firestore
- Firebase Cloud Functions, see FUNCTIONS.md to learn how to emulate functions locally (out-of-date)
- Firebase Storage
- Algolia Instant Search
Choose an already approved task from the Development Roadmap or create an issue to propose a new feature (please await discussion before creating a pull request). Read CONTRIBUTING.md to understand how to commit your changes using Git flow and then follow the instructions in Developing to get started.
Install dependencies with npm install and then run npm run dev then open on localhost:3000. The app will hot reload as you make changes. As an easy alternative you can use the Gitpod button here to open a ready-built dev environment w/ npm dependencies already installed:
*Note that on localhost you will not see the live (prod) site's data, but rather the data from the dev database, which allows us to develop and make changes freely without worrying about deleting or corrupting important data.
The simple and clean look was inspired by https://github.com/ayndqy/notecards.
- Prettier for automatic code styling on save and commit (added automatically by
create-svelte) - use the Prettier extension to activate on-save for all non-svelte files (otherwise this will only happen via theprettier --writecli command) - ESLint for automatic linting to improve code quality on commit (added automatically by
create-svelte) - simple-git-hooks + lint-staged, Note: manually run
npx simple-git-hooksevery time the simple-git-hooks configuration in package.json is changed - LighthouseCI
- Jest and WallabyJS for unit and integration tests
- Playwright (TODO) and possibly Checkly for E2E tests