/overrise-web

A web app aimed to help taking notes of the bible

Primary LanguageJavaScript

OverRise

OverRise is a website that aims to help you read the Bible.
Visit the site here!

Any Suggestions or Feedback, please create an issue or contact me, Thank you!

Development

This repo holds the web frontend of OverRise and was bootstrapped with Create React App.

Look at the server code powering this project here

Get started

Clone this repo, then:

  1. yarn
  2. yarn start

Alternatively, use npm instead of yarn.

Backend

In addition to this, you'll need to run overrise-server. The steps required to run it can be found in the repo.

Environment Variables

By default, the environment variables on development shouldn't need to be changed. However, you can create .env.local or any combination found here to override the variables as necessary.

The full list of required variables can be found in .env.production.
Do not modify the variables in this file as those will be replaced by the production server before serving to user.

Refer to .env.development to see what kind of variable is expected.

When adding new environment variables, add a new entry to both .env.production and .env.development

Docker

You can build and push the docker image using the following command:

  1. docker build -t overrise/overrise-web .
  2. docker push overrise/overrise-web
docker build -t overrise/overrise-web . && docker push overrise/overrise-web

Production

Deploying through Docker

Here's a sample docker-compose.yml file.

version: '2'
services:
  ...
  overrise-web:
    image: overrise/overrise-web
    container_name: "overrise_web"
    restart: always
    ports:
     - '80:80'
    environment:
     - REACT_APP_GRAPHQL_ENDPOINT=http://api.overrise.co.uk/api/graphql
     - REACT_APP_API_ENDPOINT=http://api.overrise.co.uk/api
     - REACT_APP_SENTRY_DSN=
  ...