-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
<!-- PROJECT LOGO --> | ||
<br /> | ||
<p align="center"> | ||
<a href=""> | ||
<img src="https://github.com/bible-technology/scribe-scripture-editor/blob/development/styles/scribe-logo.png" alt="Logo" width="80" height="80"> | ||
</a> | ||
|
||
<h3 align="center">Scribe Scripture Editor (Scribe v2)</h3> | ||
|
||
<p align="center"> | ||
A Bible translation editor for everyone. | ||
<br /> | ||
<a href="https://github.com/BiblioNexus-Foundation/scribe/issues">Report Issue</a> | ||
· | ||
<a href="https://github.com/BiblioNexus-Foundation/scribe/issues">Feature Request</a> | ||
</p> | ||
</p> | ||
|
||
<!-- GETTING STARTED --> | ||
|
||
## Getting Started | ||
|
||
It is relatively easy to set up the application locally for development. | ||
|
||
### Prerequisites | ||
|
||
This is an example of how to list things you need to use the software and how to install them. | ||
|
||
- [Node.js ^16.15.1](https://nodejs.org/en/) | ||
- [YARN ^1.7.0 <2](https://yarnpkg.com/getting-started) | ||
|
||
### Installation | ||
|
||
1. Fork and clone this repository | ||
2. Install dependencies and Build the app in development mode with `yarn run build:dev` | ||
3. Start the application(electron) with `yarn start:electron` |