Introduction

An app for your next idea!

This app uses the following technologies:

• PostgreSQL 12
• Hasura GraphQL
• Ionic Framework (React)
• AWS Cognito

Getting Started

Requirements

• git
• Docker
• (Optional) Node.js
  • Only if not using Docker, check the .tool-versions file for the Node.js version to use.

Quick Start

Clone repo

$ git clone https://github.com/mdwagner/next-great-idea.git

Use VisualStudioCode Remote Containers extension

Open Folder in Container

Create .env file in hasura/ directory with the following content:

HASURA_GRAPHQL_ENDPOINT=<insert hasura endpoint here>
HASURA_GRAPHQL_ADMIN_SECRET=<insert hasura admin secret here>

Create .env file in ionic/ directory with the following content:

REACT_APP_GRAPHQL_URL=<insert hasura graphql url here>
REACT_APP_ADMIN_SECRET=<insert hasura admin secret here>

Start up app:

$ cd ionic
$ npm ci
$ npm start

Go to localhost:8100 for Ionic Web app.

Contributing

This project uses Conventional Commits. Usage is up to developer discretion. We only ask you follow these conventions:

• commit prefix is lowercase <type>[optional scope]
  • Ex: fix(react): Fixed everything lol
• commit prefix breaking changes use !
  • Ex: refactor!: drop IE 11
• branch names can be whatever developer wants
  • Ex: whatever-i-want
  • Ex: not-master
  • Ex: ticket-123

Notes

• If you don't have your local SSH agent running locally, you may run into errors when pushing changes from inside of the container. If you are still having issues, an alternative approach is pushing changes from outside of the container.