https://github.com/rocky-jaiswal/prayer-praise-main-service

Main API for prayer-praise app
https://github.com/rocky-jaiswal/prayer-praise-main-service

Last synced: about 1 month ago
JSON representation

Main API for prayer-praise app

• Host: GitHub
• URL: https://github.com/rocky-jaiswal/prayer-praise-main-service
• Owner: rocky-jaiswal
• License: mit
• Created: 2018-01-28T18:34:36.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-11T03:42:43.000Z (almost 2 years ago)
• Last Synced: 2024-06-12T18:56:53.630Z (6 months ago)
• Language: JavaScript
• Size: 838 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# prayer-praise-main-service

HapiJS + ReactJS app for Berlin Church to share prayers and praise cards with the whole church

[![rocky-jaiswal](https://circleci.com/gh/rocky-jaiswal/prayer-praise-main-service.svg?style=svg)](https://app.circleci.com/pipelines/github/rocky-jaiswal/prayer-praise-main-service)

[![Maintainability](https://api.codeclimate.com/v1/badges/704c274baaf137146e93/maintainability)](https://codeclimate.com/github/rocky-jaiswal/prayer-praise-main-service/maintainability)

## Local setup requirements

- NodeJS (12 LTS)

- Yarn (node package manager)

- docker

- docker-compose

- Make sure PostgreSQL is not running locally otherwise there may be a port conflict with the DB started by the docker setup

## To run locally

1. Checkout the [https://github.com/rocky-jaiswal/prayer-praise-main-service](https://github.com/rocky-jaiswal/prayer-praise-main-service) and [https://github.com/rocky-jaiswal/prayer-praise-web](https://github.com/rocky-jaiswal/prayer-praise-web) projects since they are deployed individually.

2. Run `yarn install` inside web and api projects to make sure you have npm and yarn setup correctly (_techinally optional, just docker-compose should be enough to get this project running)._

3. **For the first time setup do - `docker-compose up --build` after that you do not need the '--build' flag**

4. DB migrations can be done with - `docker-compose exec main-api npm run migrate-latest`

5. DB can be seeded with some data using - `docker-compose exec main-api npm run seed-data`

6. Run `yarn start` in web project to start it separately

7. Run tests with `docker-compose exec main-api yarn test`, since the test DB also runs inside docker / docker-compose, please run _docker-compose up_ command before running the tests.

## Notes

- The application runs as a ReactJS (+ TypeScript) web application, with a NodeJS (HapiJS) REST API backend. The data is persisted in PostgreSQL RDBMS.

- The React web application is written in TypeScript for some type safety and the backend is pure NodeJS 12.x.x (for native async await support).

## Important

- The application uses Auth0 for user login, the Auth0 token is not checked into the git repo, please create your own Auth0 client for testing / local installation (it's very simple)

- Copy and change the `auth0.url` in `.config/default.yaml` and update the values for Auth0 there