App to translate Scripture step by step
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
App to translate Scripture step by step
There are 2 versions to install: V-CANA Online and V-CANA Intranet.
The online version of v-cana consists of 2 parts:
- The Supabase project, which allows you to store data.
- The NextJS application.
macOS
Install the CLI with Homebrew:
brew install supabase/tap/supabaseWindows
Install the CLI with Scoop:
scoop bucket add supabase https://github.com/supabase/scoop-bucket.git
scoop install supabaseLinux
The CLI is available through Homebrew and Linux packages.
Homebrew
brew install supabase/tap/supabaseLinux packages
Linux packages are provided in Releases. To install, download the .apk/.deb/.rpm file depending on your package manager and run one of the following:
sudo apk add --allow-untrusted <...>.apksudo dpkg -i <...>.debsudo rpm -i <...>.rpm
git clone https://github.com/texttree/v-cana.gitcd v-cana
npm install or yarn
supabase startAfter the previous step is successful, information about the database configuration will appear
API URL: http://127.0.0.1:64321
GraphQL URL: http://127.0.0.1:64321/graphql/v1
DB URL: postgresql://postgres:[email protected]:64322/postgres
Studio URL: http://127.0.0.1:64323
Inbucket URL: http://127.0.0.1:64324
JWT secret: ***
anon key: ***
service_role ***Create a copy of the env.local.example file and rename it to env.local
cp .env.local.example .env.local
Copy this information to .env.local
API URL to
SUPABASE_URL and NEXT_PUBLIC_SUPABASE_URL
anon key to
NEXT_PUBLIC_SUPABASE_ANON_KEY
service_role to
SUPABASE_SERVICE_KEY
npm run dev or yarn dev
Open http://localhost:3000/users/create and then create new user with login and email.
Authenticate under the created user
Open http://localhost:3000 and sign in.
After the first login to the site, the agreements page will open.
After all the agreements are marked, the user's personal account will open.
The first user is created with administrator rights, so the Create a project tab is available to him.
Fill in all the fields in the tab "Create a project"
In field methods choose value cana-bible-eng or cana-obs-eng
In fields List of resources add resources url from git.door43.org.
For example:
literal
https://git.door43.org/unfoldingWord/en_ult/commit/155ef870f6ea832e568a90ed0c000d3dfc15de6fsimplified
https://git.door43.org/unfoldingWord/en_ust/commit/e000eb13414df7a356efc23fd41e81eda2478065tnotes
https://git.door43.org/unfoldingWord/en_tn/commit/5a2ea85b908ddb6c25cbb7978a298babd5c21003tquestions
https://git.door43.org/unfoldingWord/en_tq/commit/4a886af618637e08094f0d1193fb56c345963afatwords
https://git.door43.org/unfoldingWord/en_twl/commit/8534077f7d32743eafa0e98b4088ef75f49027e7or
obs
https://git.door43.org/unfoldingWord/en_obs/commit/07d949fbab7be5e967b385f4da5d034fae1b9b32 tnotes
https://git.door43.org/unfoldingWord/en_obs-tn/commit/9407660e7e453348174843436c1053dd78f26320tquestions
https://git.door43.org/unfoldingWord/en_obs-tq/commit/0ee93b9dbb5f5e89580c8bfa6f9c1d07976536edtwords
https://git.door43.org/unfoldingWord/en_obs-twl/commit/44ebc9fafe8101665f985007d566f5036a2be85bThen click Create project
Choose and add translator.
Create book in list of books. Then create chapter in list of chapters. Then in assigment page push button Select all, then Assign and Start the chapter.
After that, a link to the translate will appear in your personal account.
- Recommendations and system requirements
- Installation of the necessary environment
- Installing the V-cana Intranet
- Loading local resources
- Connecting to the server
- Creating users
- Creating a project
We recommend installing V-CANA Intranet on a computer with a Linux system (tested on Linux mint 21.3) and at least 16 GB of RAM.
In this instruction, we assume that the installation is carried out on a clean system without previously installed docker images.
If you do have docker images already installed, you may already have some containers running and certain ports are busy. In this case, you may need to customize the files individually .env and docker-compose.yml.
Install nvm. The latest version
Example of installing version 0.39.5:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
Install the stable version of NodeJS
nvm install --lts
npm install --global yarn
sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list
sudo apt update
sudo apt install caddy
The official instructions differ for different versions of Linux We recommend contacting here - https://docs.docker.com/engine/install/
This is necessary in order to execute scripts with the docker cli without using sudo.
Instructions - https://docs.docker.com/engine/install/linux-postinstall/
Example:
sudo groupadd docker
sudo usermod -aG docker $USER
newgrp docker
service docker start
In our test, we emulated the installation on a computer that works completely without the Internet.
For successful installation in this case, you need to prepare docker images on a computer with the Internet.
Download the archive
Unzip it.
bash export-images.sh
As a result, an archive will be saved in the root of the folder docker-images.gz.
From this point on, you can copy the entire folder to the computer prepared for the installation of the V-CANA Intranet.
bash install-images.sh
It will unpack and install all the necessary docker images.
bash install-vcana.sh
It will download the latest version of the V-CANA application from github and configure the necessary folders for the server side to work.
bash prepare-network.sh
It will help you set up all the files responsible for configuring the server and network.
bash run.sh
The script runs all containers.
Access to V-CANA on the server will be at http://localhost:4004
Access to the server emulating dcs will be at http://localhost:4008
For V-CANA Intranet to work successfully, you need locally downloaded archives of resources from which you will translate: literal Bible, simplified Bible, tNotes, tWords, tWordsLinks, tQuestions, Greek Bible and Hebrew Bible.
You can download it on the https://git.door43.org.
Then go to the url http://localhost:4008.
Here, in the owner field, write the owner of the repo, let's say unfoldingWord, and in the repo name field, let's say en_ult, select the archive and click Submit. So you need to download all the resources.
Remember the owner and repo, they will be useful to you further.
The scheme only works for users within the same network.
Connect all devices to the same network. Then start the server. After successfully launching all containers, need to find out the ip address of the server. This can be found out both from the network properties and in the configuration file, which will be overwritten every time the server is started - .env
The received ip address is entered into any client browser with the required port.
[BASE_HOST]:4008 - V-CANA application
[BASE_HOST]:4004 - resource settings and updates page.
Before creating a project, you need to create a user who has the maximum level of access to all pages.
To do this, go to the [BASE_HOST]:4008/users/create page, enter your email, username and password and register. Only the first created user gets root rights, all subsequent users will be regular users of the application.
Fill in all the fields in the tab "Create a project"
In field methods choose value cana-bible-eng or cana-obs-eng
In fields List of resources add resources url from [BASE_HOST]:4008
Using the owner and repo from the step Loading local resources
literal
http://192.168.1.12:4008/unfoldingWord/en_ult/src/commit/mastersimplified
http://192.168.1.12:4008/unfoldingWord/en_ult/src/commit/mastertnotes
https://192.168.1.12:4008/unfoldingWord/en_tn/commit/mastertquestions
https://192.168.1.12:4008/unfoldingWord/en_tq/commit/mastertwords
https://192.168.1.12:4008/unfoldingWord/en_twl/commit/masteror
obs
https://192.168.1.12:4008/unfoldingWord/en_obs/commit/master tnotes
https://192.168.1.12:4008/unfoldingWord/en_obs-tn/commit/mastertquestions
https://192.168.1.12:4008/unfoldingWord/en_obs-tq/commit/mastertwords
https://192.168.1.12:4008/unfoldingWord/en_obs-twl/commit/masterThen click Create project
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
- [] Feature 1
- [] Feature 2
- [] Feature 3
- [] Nested Feature
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Guidelines for external contributions.
You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
If you would like to fork the repo and create a pull request.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Discord: V-CANA
Project Link: https://github.com/texttree/v-cana