Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mdwagner/next-great-idea
An app for your next idea!
https://github.com/mdwagner/next-great-idea
conventions docker hacktoberfest hasura ionic nestjs-graphql postgresql
Last synced: about 1 month ago
JSON representation
An app for your next idea!
- Host: GitHub
- URL: https://github.com/mdwagner/next-great-idea
- Owner: mdwagner
- License: mit
- Created: 2020-05-22T04:02:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-03-29T01:24:43.000Z (almost 4 years ago)
- Last Synced: 2023-03-12T00:16:35.608Z (almost 2 years ago)
- Topics: conventions, docker, hacktoberfest, hasura, ionic, nestjs-graphql, postgresql
- Language: TypeScript
- Homepage:
- Size: 1.07 MB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
 
An app for your _next_ idea!
## This app uses the following technologies:
- [PostgreSQL 12](https://www.postgresql.org/docs/12/)
- [Hasura GraphQL](https://hasura.io/docs/1.0/graphql/manual/index.html)
- [Ionic Framework (React)](https://ionicframework.com/docs)
- [AWS Cognito](https://aws.amazon.com/cognito/)
## Getting Started
### Requirements
- [git](https://git-scm.com/)
- [Docker](https://www.docker.com/)
- (Optional) [Node.js](https://nodejs.org/)
- Only if not using Docker, check the `.tool-versions` file for the Node.js version to use.
### Quick Start
#### Clone repo
```sh
$ git clone https://github.com/mdwagner/next-great-idea.git
```
#### Use [VisualStudioCode Remote Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
```
Open Folder in Container
```
#### Create .env file in **hasura/** directory with the following content:
```sh
HASURA_GRAPHQL_ENDPOINT=
HASURA_GRAPHQL_ADMIN_SECRET=
```
#### Create .env file in **ionic/** directory with the following content:
```sh
REACT_APP_GRAPHQL_URL=
REACT_APP_ADMIN_SECRET=
```
#### Start up app:
```sh
$ cd ionic
$ npm ci
$ npm start
```
Go to [localhost:8100](http://localhost:8100) for Ionic Web app.
## Contributing
This project uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Usage is up to developer discretion. We only ask you follow these conventions:
- commit prefix is lowercase `[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](https://code.visualstudio.com/docs/remote/containers#_using-ssh-keys), 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.