From 3c531e9de10044438927a5860d7f8e322806e5c2 Mon Sep 17 00:00:00 2001 From: Adrian Rocke Date: Tue, 26 Nov 2024 13:07:04 -0600 Subject: [PATCH] chore: update README with vision and roadmap --- README.md | 71 +++++++++++++++++++++++++++---------------------------- 1 file changed, 35 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index ba0f626..408b0e0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,35 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# Global Bible Tools + +## Vision + +Our goal is to build biblical Hebrew and Greek study tools for the global church. Read more at [globalbibletools.com](https://globalbibletools.com) + +## Roadmap + +### Current Work + +#### Reader's Bible +The first step is to build a platform where volunteers can translate each word of the Bible into the languages of the world. +The result will power a public facing digital Reader's Bible to augment [Hebrew](https://www.youtube.com/@AlephwithBeth) and [Greek](https://www.youtube.com/@AlphawithAngela) video lessons. +This work is in progress and more details can be found in the [GitHub project](https://github.com/orgs/globalbibletools/projects/1/views/1). + +### Future Work + +#### Study App +Once we have a Reader's Bible in a few languages, we want to make it available through a native app for both Android and iPhone. +As we are able to translate additional resources, we will make them available in the app as well. + +#### Additional Resources +We intend to build similar interfaces to translate the following resources for the study app: +* **Lexicons**: Users will be able to learn, in their own language, the breadth of meaning for a Hebrew or Greek word. +* **Grammars**: Users will be able to learn, in their own langauge, the grammatical structure of Hebrew and Greek in their language. +* **Textual Critism Notes**: Users will be able to learn, in their own language, about the variants in the manuscript evidence for the Hebrew and Greek scriptures. + +## Contributing + +We are excited to add new contributors! If you are interested, +please review our [contributing guidelines](https://github.com/globalbibletools/platform/blob/main/.github/CONTRIBUTING.md) to get started. +and fill out [this form](https://enormous-square-660.notion.site/1468e90207d68038b9e5f22949d40b87?pvs=105). ## Docker @@ -26,6 +57,9 @@ docker exec -it [platform-db-1|platform-server-1] [bash|sh] ## Database +If you are using docker, then you shouldn't need to set up the database. +It will be set up for you when you start the docker image. + ### Set up database If you are running these from the db container, you can use an absolute URL (`/db/data.dump`) because the db directory is mounted at the root of the container. @@ -58,38 +92,3 @@ We will run these manually in production as needed. ```bash psql DATABASE_URL -f db/migrations/{migration}.sql ``` - -## Getting Started - -First, run the development server: - -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` - -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.