unfoldwingWord Next.js Application Template

An experiment to create an unfoldingWord template for Next.js based applications.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Purpose

• The purpose of this project is to create an unfoldingWord template for Next.js based applications to allow developers to easily get started with an app without a lot of boilerplate code.

Problem

• The process to get started with a new POC or MVP application should be quick and easy so that developers can validate the feasibility of their ideas, features, and solution to problems.

Background

• Increase velocity of starting a new application
• Increase consistency and adherence to unfoldingWord branding

(back to top)

Built With

• Next.js
• React.js
• tailwindcss

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Q. Why would you want to run the template?

A. You will run the template in order to improve it, test it, extend it, etc.

Prerequisites

Things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation/First Steps

1. Clone the repo

   git clone https://github.com/unfoldingWord-box3/next-js-template.git

NOTE: alternativiely, the repo may be forked.

1. Install NPM packages

   npm install

   or

   yarn install

2. Run the app

   npm run dev

   or

   yarn dev

3. Point browser to localhost:3000

4. Create a branch to contain your changes.

5. Make changes, commit, and push to your branch.

6. When changes are complete, create Pull Request (PR) and request they be reviewed and merged.

(back to top)

Usage/Integration

Q. Why would you want to use the template?

A. You will use the template to create a new unfoldingWord application.

Steps

• Update package.json as needed
• There are these places where the app name must be updated:
  • package.json
  • src/common/constants.js
  • src/common/sendFeedback.js

Please refer to the Nextjs Readme for more Nextjs specific documentation.

Using the Tutorials

TBD... here point to one or more tutorials showing how to use the template to actually develop something useful...

Potential Ideas:

• Using the Bible Reference RCL with Proskomma
• Using the Translation Helps RCL to display content

(back to top)

Roadmap

• POC
• Prototype
• MVP

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature-github_username-AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

unfoldingWord - @unfoldingWord - info@unfoldingWord.org

Project Link: https://github.com/unfoldingWord-box3/next-js-template

(back to top)

Acknowledgments

(back to top)