https://github.com/bridgeconn/usfm-grammar-online
USFM-Grammar on the web
https://github.com/bridgeconn/usfm-grammar-online
Last synced: 11 months ago
JSON representation
USFM-Grammar on the web
- Host: GitHub
- URL: https://github.com/bridgeconn/usfm-grammar-online
- Owner: Bridgeconn
- License: mit
- Created: 2020-09-03T06:37:51.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-30T17:02:02.000Z (almost 2 years ago)
- Last Synced: 2024-07-30T21:19:13.554Z (almost 2 years ago)
- Language: JavaScript
- Homepage: https://usfmgrammar.vachanengine.org/
- Size: 646 KB
- Stars: 0
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# usfm-grammar-online
This is a web service made using React JS to provide a user interface for [USFM-Grammar](https://github.com/Bridgeconn/usfm-grammar)
### Demo URL
- https://usfmgrammar.vachanengine.org/
## Prerequisites
- [Node JS](https://nodejs.org/en/) 20 or above.
- [NPM](https://www.npmjs.com)
Preferably installed via [nvm](https://nodejs.org/en/download)
## Get the code
Clone the [git repository](https://github.com/Bridgeconn/usfm-grammar-online.git) or download the zip and extract it
```bash
git clone https://github.com/Bridgeconn/usfm-grammar-online.git
```
## Local Deployment Steps
1. Open a terminal and go to the web-app-V3 folder
`cd web-app-v3`
2. Install the dependencies
`npm install`
3. Start the server
`npm run dev`
4. Go to http://localhost:5173
## Production Deployment Steps
The production build folder can be created using the following command
```bash
npm run build
```
You can use a hosted solution like [Netlify](https://www.netlify.com/) / [Vercel](https://vercel.com/) or deploy it using a web server like [NginX](https://www.nginx.com/) on your own server.
Steps to deploy a react application with NginX - [Link](https://www.digitalocean.com/community/tutorials/how-to-deploy-a-react-application-with-nginx-on-ubuntu-20-04)