Skip to content

Commit

Permalink
Super Graph renamed to GraphJin
Browse files Browse the repository at this point in the history
  • Loading branch information
dosco committed Dec 16, 2020
1 parent 5730736 commit 10c1374
Show file tree
Hide file tree
Showing 126 changed files with 229,220 additions and 6,388 deletions.
2 changes: 1 addition & 1 deletion .chglog/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ style: github
template: CHANGELOG.tpl.md
info:
title: CHANGELOG
repository_url: https://github.com/dosco/super-graph
repository_url: https://github.com/dosco/graphjin
options:
commits:
filters:
Expand Down
2 changes: 1 addition & 1 deletion .deepsource.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ name = "go"
enabled = true

[analyzers.meta]
import_path = "github.com/dosco/super-graph"
import_path = "github.com/dosco/graphjin"
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ assignees: ''

<!-- If you suspect this could be a bug, follow the template. -->

### What version of Super Graph are you using? `super-graph version`
### What version of GraphJin are you using? `graphjin version`


### Have you tried reproducing the issue with the latest release?
Expand All @@ -18,7 +18,7 @@ assignees: ''
### What is the hardware spec (RAM, OS)?


### Steps to reproduce the issue (config used to run Super Graph).
### Steps to reproduce the issue (config used to run GraphJin).


### Expected behaviour and actual result.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ assignees: ''

---

<!-- If you think the Super Graph documentation falls short https://supergraph.dev/guide.html please suggest ways we can improve it. -->
<!-- If you think the GraphJin documentation falls short https://graphjin.com/guide.html please suggest ways we can improve it. -->

<!-- explain it here. -->
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
.swp
.release
main
super-graph
graphjin
*-fuzz.zip
crashers
suppressions
Expand Down
198 changes: 99 additions & 99 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<a name="v0.13.16"></a>
## [v0.13.16] - 2020-04-21
### Features
- feat : improve the generated introspection schema and avoid the chirino/graphql api leaking through the core api. ([#53](https://github.com/dosco/super-graph/issues/53))
- feat : improve the generated introspection schema and avoid the chirino/graphql api leaking through the core api. ([#53](https://github.com/dosco/graphjin/issues/53))


<a name="v0.13.15"></a>
Expand Down Expand Up @@ -128,7 +128,7 @@
<a name="v0.12.32"></a>
## [v0.12.32] - 2020-02-24
### Bug Fixes
- fix "Try the demo app" in docs ([#38](https://github.com/dosco/super-graph/issues/38))
- fix "Try the demo app" in docs ([#38](https://github.com/dosco/graphjin/issues/38))


<a name="v0.12.31"></a>
Expand Down Expand Up @@ -206,7 +206,7 @@
<a name="v0.12.7"></a>
## [v0.12.7] - 2020-01-11
### Pull Requests
- Merge pull request [#22](https://github.com/dosco/super-graph/issues/22) from bhaskarmurthy/fix-grammer-syntax
- Merge pull request [#22](https://github.com/dosco/graphjin/issues/22) from bhaskarmurthy/fix-grammer-syntax


<a name="v0.12.6"></a>
Expand Down Expand Up @@ -260,19 +260,19 @@
<a name="v0.11"></a>
## [v0.11] - 2019-11-01
### Pull Requests
- Merge pull request [#11](https://github.com/dosco/super-graph/issues/11) from dosco/rbac
- Merge pull request [#11](https://github.com/dosco/graphjin/issues/11) from dosco/rbac


<a name="v0.10.1"></a>
## [v0.10.1] - 2019-10-06
### Pull Requests
- Merge pull request [#10](https://github.com/dosco/super-graph/issues/10) from FourSigma/sm-examples-folder
- Merge pull request [#10](https://github.com/dosco/graphjin/issues/10) from FourSigma/sm-examples-folder


<a name="v0.10"></a>
## [v0.10] - 2019-10-04
### Pull Requests
- Merge pull request [#6](https://github.com/dosco/super-graph/issues/6) from muesli/typo-fixes
- Merge pull request [#6](https://github.com/dosco/graphjin/issues/6) from muesli/typo-fixes


<a name="v0.9"></a>
Expand All @@ -299,96 +299,96 @@
<a name="0.3"></a>
## 0.3 - 2019-03-24

[Unreleased]: https://github.com/dosco/super-graph/compare/v0.13.22...HEAD
[v0.13.22]: https://github.com/dosco/super-graph/compare/v0.13.21...v0.13.22
[v0.13.21]: https://github.com/dosco/super-graph/compare/v0.13.20...v0.13.21
[v0.13.20]: https://github.com/dosco/super-graph/compare/v0.13.19...v0.13.20
[v0.13.19]: https://github.com/dosco/super-graph/compare/v0.13.18...v0.13.19
[v0.13.18]: https://github.com/dosco/super-graph/compare/v0.13.17...v0.13.18
[v0.13.17]: https://github.com/dosco/super-graph/compare/v0.13.16...v0.13.17
[v0.13.16]: https://github.com/dosco/super-graph/compare/v0.13.15...v0.13.16
[v0.13.15]: https://github.com/dosco/super-graph/compare/v0.13.14...v0.13.15
[v0.13.14]: https://github.com/dosco/super-graph/compare/v0.13.13...v0.13.14
[v0.13.13]: https://github.com/dosco/super-graph/compare/v0.13.12...v0.13.13
[v0.13.12]: https://github.com/dosco/super-graph/compare/v0.13.11...v0.13.12
[v0.13.11]: https://github.com/dosco/super-graph/compare/v0.13.10...v0.13.11
[v0.13.10]: https://github.com/dosco/super-graph/compare/v0.13.9...v0.13.10
[v0.13.9]: https://github.com/dosco/super-graph/compare/v0.13.8...v0.13.9
[v0.13.8]: https://github.com/dosco/super-graph/compare/v0.13.7...v0.13.8
[v0.13.7]: https://github.com/dosco/super-graph/compare/v0.13.6...v0.13.7
[v0.13.6]: https://github.com/dosco/super-graph/compare/v0.13.5...v0.13.6
[v0.13.5]: https://github.com/dosco/super-graph/compare/v0.13.4...v0.13.5
[v0.13.4]: https://github.com/dosco/super-graph/compare/v0.13.3...v0.13.4
[v0.13.3]: https://github.com/dosco/super-graph/compare/v0.13.2...v0.13.3
[v0.13.2]: https://github.com/dosco/super-graph/compare/v0.13.1...v0.13.2
[v0.13.1]: https://github.com/dosco/super-graph/compare/v0.13.0...v0.13.1
[v0.13.0]: https://github.com/dosco/super-graph/compare/v0.12.49...v0.13.0
[v0.12.49]: https://github.com/dosco/super-graph/compare/v0.12.48...v0.12.49
[v0.12.48]: https://github.com/dosco/super-graph/compare/v0.12.47...v0.12.48
[v0.12.47]: https://github.com/dosco/super-graph/compare/v0.12.46...v0.12.47
[v0.12.46]: https://github.com/dosco/super-graph/compare/v0.12.45...v0.12.46
[v0.12.45]: https://github.com/dosco/super-graph/compare/v0.12.44...v0.12.45
[v0.12.44]: https://github.com/dosco/super-graph/compare/v0.12.43...v0.12.44
[v0.12.43]: https://github.com/dosco/super-graph/compare/v0.12.42...v0.12.43
[v0.12.42]: https://github.com/dosco/super-graph/compare/v0.12.41...v0.12.42
[v0.12.41]: https://github.com/dosco/super-graph/compare/v0.12.40...v0.12.41
[v0.12.40]: https://github.com/dosco/super-graph/compare/v0.12.39...v0.12.40
[v0.12.39]: https://github.com/dosco/super-graph/compare/v0.12.38...v0.12.39
[v0.12.38]: https://github.com/dosco/super-graph/compare/v0.12.37...v0.12.38
[v0.12.37]: https://github.com/dosco/super-graph/compare/v0.12.36...v0.12.37
[v0.12.36]: https://github.com/dosco/super-graph/compare/v0.12.35...v0.12.36
[v0.12.35]: https://github.com/dosco/super-graph/compare/v0.12.34...v0.12.35
[v0.12.34]: https://github.com/dosco/super-graph/compare/v0.12.33...v0.12.34
[v0.12.33]: https://github.com/dosco/super-graph/compare/v0.12.32...v0.12.33
[v0.12.32]: https://github.com/dosco/super-graph/compare/v0.12.31...v0.12.32
[v0.12.31]: https://github.com/dosco/super-graph/compare/v0.12.30...v0.12.31
[v0.12.30]: https://github.com/dosco/super-graph/compare/v0.12.29...v0.12.30
[v0.12.29]: https://github.com/dosco/super-graph/compare/v0.12.28...v0.12.29
[v0.12.28]: https://github.com/dosco/super-graph/compare/v0.12.27...v0.12.28
[v0.12.27]: https://github.com/dosco/super-graph/compare/v0.12.26...v0.12.27
[v0.12.26]: https://github.com/dosco/super-graph/compare/v0.12.25...v0.12.26
[v0.12.25]: https://github.com/dosco/super-graph/compare/v0.12.24...v0.12.25
[v0.12.24]: https://github.com/dosco/super-graph/compare/v0.12.23...v0.12.24
[v0.12.23]: https://github.com/dosco/super-graph/compare/v0.12.22...v0.12.23
[v0.12.22]: https://github.com/dosco/super-graph/compare/v0.12.21...v0.12.22
[v0.12.21]: https://github.com/dosco/super-graph/compare/v0.12.20...v0.12.21
[v0.12.20]: https://github.com/dosco/super-graph/compare/v0.12.19...v0.12.20
[v0.12.19]: https://github.com/dosco/super-graph/compare/v0.12.18...v0.12.19
[v0.12.18]: https://github.com/dosco/super-graph/compare/v0.12.17...v0.12.18
[v0.12.17]: https://github.com/dosco/super-graph/compare/v0.12.16...v0.12.17
[v0.12.16]: https://github.com/dosco/super-graph/compare/v0.12.15...v0.12.16
[v0.12.15]: https://github.com/dosco/super-graph/compare/v0.12.14...v0.12.15
[v0.12.14]: https://github.com/dosco/super-graph/compare/v0.12.13...v0.12.14
[v0.12.13]: https://github.com/dosco/super-graph/compare/v0.12.12...v0.12.13
[v0.12.12]: https://github.com/dosco/super-graph/compare/v0.12.11...v0.12.12
[v0.12.11]: https://github.com/dosco/super-graph/compare/v0.12.10...v0.12.11
[v0.12.10]: https://github.com/dosco/super-graph/compare/v0.12.9...v0.12.10
[v0.12.9]: https://github.com/dosco/super-graph/compare/v0.12.8...v0.12.9
[v0.12.8]: https://github.com/dosco/super-graph/compare/v0.12.7...v0.12.8
[v0.12.7]: https://github.com/dosco/super-graph/compare/v0.12.6...v0.12.7
[v0.12.6]: https://github.com/dosco/super-graph/compare/v0.12.5...v0.12.6
[v0.12.5]: https://github.com/dosco/super-graph/compare/v0.12.4...v0.12.5
[v0.12.4]: https://github.com/dosco/super-graph/compare/v0.12.3...v0.12.4
[v0.12.3]: https://github.com/dosco/super-graph/compare/v0.12.2...v0.12.3
[v0.12.2]: https://github.com/dosco/super-graph/compare/v0.12.1...v0.12.2
[v0.12.1]: https://github.com/dosco/super-graph/compare/v0.12.0...v0.12.1
[v0.12.0]: https://github.com/dosco/super-graph/compare/v0.11.9...v0.12.0
[v0.11.9]: https://github.com/dosco/super-graph/compare/v0.11.8...v0.11.9
[v0.11.8]: https://github.com/dosco/super-graph/compare/v0.11.7...v0.11.8
[v0.11.7]: https://github.com/dosco/super-graph/compare/v0.11.6...v0.11.7
[v0.11.6]: https://github.com/dosco/super-graph/compare/v0.11.5...v0.11.6
[v0.11.5]: https://github.com/dosco/super-graph/compare/v0.11.4...v0.11.5
[v0.11.4]: https://github.com/dosco/super-graph/compare/v0.11.3...v0.11.4
[v0.11.3]: https://github.com/dosco/super-graph/compare/v0.11.2...v0.11.3
[v0.11.2]: https://github.com/dosco/super-graph/compare/v0.11.1...v0.11.2
[v0.11.1]: https://github.com/dosco/super-graph/compare/v0.11...v0.11.1
[v0.11]: https://github.com/dosco/super-graph/compare/v0.10.1...v0.11
[v0.10.1]: https://github.com/dosco/super-graph/compare/v0.10...v0.10.1
[v0.10]: https://github.com/dosco/super-graph/compare/v0.9...v0.10
[v0.9]: https://github.com/dosco/super-graph/compare/v0.8...v0.9
[v0.8]: https://github.com/dosco/super-graph/compare/v0.7...v0.8
[v0.7]: https://github.com/dosco/super-graph/compare/v0.6...v0.7
[v0.6]: https://github.com/dosco/super-graph/compare/v0.5...v0.6
[v0.5]: https://github.com/dosco/super-graph/compare/v0.4...v0.5
[v0.4]: https://github.com/dosco/super-graph/compare/v0.3...v0.4
[v0.3]: https://github.com/dosco/super-graph/compare/0.3...v0.3
[Unreleased]: https://github.com/dosco/graphjin/compare/v0.13.22...HEAD
[v0.13.22]: https://github.com/dosco/graphjin/compare/v0.13.21...v0.13.22
[v0.13.21]: https://github.com/dosco/graphjin/compare/v0.13.20...v0.13.21
[v0.13.20]: https://github.com/dosco/graphjin/compare/v0.13.19...v0.13.20
[v0.13.19]: https://github.com/dosco/graphjin/compare/v0.13.18...v0.13.19
[v0.13.18]: https://github.com/dosco/graphjin/compare/v0.13.17...v0.13.18
[v0.13.17]: https://github.com/dosco/graphjin/compare/v0.13.16...v0.13.17
[v0.13.16]: https://github.com/dosco/graphjin/compare/v0.13.15...v0.13.16
[v0.13.15]: https://github.com/dosco/graphjin/compare/v0.13.14...v0.13.15
[v0.13.14]: https://github.com/dosco/graphjin/compare/v0.13.13...v0.13.14
[v0.13.13]: https://github.com/dosco/graphjin/compare/v0.13.12...v0.13.13
[v0.13.12]: https://github.com/dosco/graphjin/compare/v0.13.11...v0.13.12
[v0.13.11]: https://github.com/dosco/graphjin/compare/v0.13.10...v0.13.11
[v0.13.10]: https://github.com/dosco/graphjin/compare/v0.13.9...v0.13.10
[v0.13.9]: https://github.com/dosco/graphjin/compare/v0.13.8...v0.13.9
[v0.13.8]: https://github.com/dosco/graphjin/compare/v0.13.7...v0.13.8
[v0.13.7]: https://github.com/dosco/graphjin/compare/v0.13.6...v0.13.7
[v0.13.6]: https://github.com/dosco/graphjin/compare/v0.13.5...v0.13.6
[v0.13.5]: https://github.com/dosco/graphjin/compare/v0.13.4...v0.13.5
[v0.13.4]: https://github.com/dosco/graphjin/compare/v0.13.3...v0.13.4
[v0.13.3]: https://github.com/dosco/graphjin/compare/v0.13.2...v0.13.3
[v0.13.2]: https://github.com/dosco/graphjin/compare/v0.13.1...v0.13.2
[v0.13.1]: https://github.com/dosco/graphjin/compare/v0.13.0...v0.13.1
[v0.13.0]: https://github.com/dosco/graphjin/compare/v0.12.49...v0.13.0
[v0.12.49]: https://github.com/dosco/graphjin/compare/v0.12.48...v0.12.49
[v0.12.48]: https://github.com/dosco/graphjin/compare/v0.12.47...v0.12.48
[v0.12.47]: https://github.com/dosco/graphjin/compare/v0.12.46...v0.12.47
[v0.12.46]: https://github.com/dosco/graphjin/compare/v0.12.45...v0.12.46
[v0.12.45]: https://github.com/dosco/graphjin/compare/v0.12.44...v0.12.45
[v0.12.44]: https://github.com/dosco/graphjin/compare/v0.12.43...v0.12.44
[v0.12.43]: https://github.com/dosco/graphjin/compare/v0.12.42...v0.12.43
[v0.12.42]: https://github.com/dosco/graphjin/compare/v0.12.41...v0.12.42
[v0.12.41]: https://github.com/dosco/graphjin/compare/v0.12.40...v0.12.41
[v0.12.40]: https://github.com/dosco/graphjin/compare/v0.12.39...v0.12.40
[v0.12.39]: https://github.com/dosco/graphjin/compare/v0.12.38...v0.12.39
[v0.12.38]: https://github.com/dosco/graphjin/compare/v0.12.37...v0.12.38
[v0.12.37]: https://github.com/dosco/graphjin/compare/v0.12.36...v0.12.37
[v0.12.36]: https://github.com/dosco/graphjin/compare/v0.12.35...v0.12.36
[v0.12.35]: https://github.com/dosco/graphjin/compare/v0.12.34...v0.12.35
[v0.12.34]: https://github.com/dosco/graphjin/compare/v0.12.33...v0.12.34
[v0.12.33]: https://github.com/dosco/graphjin/compare/v0.12.32...v0.12.33
[v0.12.32]: https://github.com/dosco/graphjin/compare/v0.12.31...v0.12.32
[v0.12.31]: https://github.com/dosco/graphjin/compare/v0.12.30...v0.12.31
[v0.12.30]: https://github.com/dosco/graphjin/compare/v0.12.29...v0.12.30
[v0.12.29]: https://github.com/dosco/graphjin/compare/v0.12.28...v0.12.29
[v0.12.28]: https://github.com/dosco/graphjin/compare/v0.12.27...v0.12.28
[v0.12.27]: https://github.com/dosco/graphjin/compare/v0.12.26...v0.12.27
[v0.12.26]: https://github.com/dosco/graphjin/compare/v0.12.25...v0.12.26
[v0.12.25]: https://github.com/dosco/graphjin/compare/v0.12.24...v0.12.25
[v0.12.24]: https://github.com/dosco/graphjin/compare/v0.12.23...v0.12.24
[v0.12.23]: https://github.com/dosco/graphjin/compare/v0.12.22...v0.12.23
[v0.12.22]: https://github.com/dosco/graphjin/compare/v0.12.21...v0.12.22
[v0.12.21]: https://github.com/dosco/graphjin/compare/v0.12.20...v0.12.21
[v0.12.20]: https://github.com/dosco/graphjin/compare/v0.12.19...v0.12.20
[v0.12.19]: https://github.com/dosco/graphjin/compare/v0.12.18...v0.12.19
[v0.12.18]: https://github.com/dosco/graphjin/compare/v0.12.17...v0.12.18
[v0.12.17]: https://github.com/dosco/graphjin/compare/v0.12.16...v0.12.17
[v0.12.16]: https://github.com/dosco/graphjin/compare/v0.12.15...v0.12.16
[v0.12.15]: https://github.com/dosco/graphjin/compare/v0.12.14...v0.12.15
[v0.12.14]: https://github.com/dosco/graphjin/compare/v0.12.13...v0.12.14
[v0.12.13]: https://github.com/dosco/graphjin/compare/v0.12.12...v0.12.13
[v0.12.12]: https://github.com/dosco/graphjin/compare/v0.12.11...v0.12.12
[v0.12.11]: https://github.com/dosco/graphjin/compare/v0.12.10...v0.12.11
[v0.12.10]: https://github.com/dosco/graphjin/compare/v0.12.9...v0.12.10
[v0.12.9]: https://github.com/dosco/graphjin/compare/v0.12.8...v0.12.9
[v0.12.8]: https://github.com/dosco/graphjin/compare/v0.12.7...v0.12.8
[v0.12.7]: https://github.com/dosco/graphjin/compare/v0.12.6...v0.12.7
[v0.12.6]: https://github.com/dosco/graphjin/compare/v0.12.5...v0.12.6
[v0.12.5]: https://github.com/dosco/graphjin/compare/v0.12.4...v0.12.5
[v0.12.4]: https://github.com/dosco/graphjin/compare/v0.12.3...v0.12.4
[v0.12.3]: https://github.com/dosco/graphjin/compare/v0.12.2...v0.12.3
[v0.12.2]: https://github.com/dosco/graphjin/compare/v0.12.1...v0.12.2
[v0.12.1]: https://github.com/dosco/graphjin/compare/v0.12.0...v0.12.1
[v0.12.0]: https://github.com/dosco/graphjin/compare/v0.11.9...v0.12.0
[v0.11.9]: https://github.com/dosco/graphjin/compare/v0.11.8...v0.11.9
[v0.11.8]: https://github.com/dosco/graphjin/compare/v0.11.7...v0.11.8
[v0.11.7]: https://github.com/dosco/graphjin/compare/v0.11.6...v0.11.7
[v0.11.6]: https://github.com/dosco/graphjin/compare/v0.11.5...v0.11.6
[v0.11.5]: https://github.com/dosco/graphjin/compare/v0.11.4...v0.11.5
[v0.11.4]: https://github.com/dosco/graphjin/compare/v0.11.3...v0.11.4
[v0.11.3]: https://github.com/dosco/graphjin/compare/v0.11.2...v0.11.3
[v0.11.2]: https://github.com/dosco/graphjin/compare/v0.11.1...v0.11.2
[v0.11.1]: https://github.com/dosco/graphjin/compare/v0.11...v0.11.1
[v0.11]: https://github.com/dosco/graphjin/compare/v0.10.1...v0.11
[v0.10.1]: https://github.com/dosco/graphjin/compare/v0.10...v0.10.1
[v0.10]: https://github.com/dosco/graphjin/compare/v0.9...v0.10
[v0.9]: https://github.com/dosco/graphjin/compare/v0.8...v0.9
[v0.8]: https://github.com/dosco/graphjin/compare/v0.7...v0.8
[v0.7]: https://github.com/dosco/graphjin/compare/v0.6...v0.7
[v0.6]: https://github.com/dosco/graphjin/compare/v0.5...v0.6
[v0.5]: https://github.com/dosco/graphjin/compare/v0.4...v0.5
[v0.4]: https://github.com/dosco/graphjin/compare/v0.3...v0.4
[v0.3]: https://github.com/dosco/graphjin/compare/0.3...v0.3
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Contributing to Super Graph
# Contributing to GraphJin

Super Graph is a very approchable code-base and a project that is easy for almost
GraphJin is a very approchable code-base and a project that is easy for almost
anyone with basic GO knowledge to start contributing to. It is also a young project
so a lot of high value work is there for the taking.

Even the GraphQL to SQL compiler that is at the heart of Super Graph is essentially a text book compiler with clean and easy to read code. The data structures used by the lexer, parser and sql generator are easy to understand and modify.
Even the GraphQL to SQL compiler that is at the heart of GraphJin is essentially a text book compiler with clean and easy to read code. The data structures used by the lexer, parser and sql generator are easy to understand and modify.

Finally we do have a lot of test for critical parts of the codebase which makes it easy for you to modify with confidence. I'm always available for questions or any sort of guidance so feel fee to reach out over twitter or discord.

* [Getting Started](#getting-started)
* [Setting Up the Development Environment](#setup-development-environment)
* [Prerequisites](#prerequisites)
* [Get the Super Graph source](#get-source-code)
* [Get the GraphJin source](#get-source-code)
* [Start the development envoirnment ](#start-the-development-envoirnment)
* [Testing](#testing-and-linting)
* [Contributing](#contributing)
Expand All @@ -20,7 +20,7 @@ Finally we do have a lot of test for critical parts of the codebase which makes

## Getting Started

- Read the [Getting Started Guide](https://supergraph.dev/guide.html#get-started)
- Read the [Getting Started Guide](https://graphjin.com/guide.html#get-started)

## Setup Development Environment

Expand All @@ -36,14 +36,14 @@ The entire build flow uses `Makefile` there is a whole list of sub-commands you
can use to build, test, install, lint, etc.

```bash
git clone https://github.com/dosco/super-graph
cd ./super-graph
git clone https://github.com/dosco/graphjin
cd ./graphjin
make help
```

### Start the development envoirnment

The entire development flow is packaged into a `docker-compose` work flow. The below `up` command will launch A Postgres database, a example e-commerce app in Rails and Super Graph in development mode. The `db:seed` Rails task will insert sample data into Postgres.
The entire development flow is packaged into a `docker-compose` work flow. The below `up` command will launch A Postgres database, a example e-commerce app in Rails and GraphJin in development mode. The `db:seed` Rails task will insert sample data into Postgres.

```bash
docker-compose -f docker-compose.yml run rails_app rake db:create db:migrate db:seed
Expand All @@ -52,7 +52,7 @@ docker-compose up

### Learn how the code works

[Super Graph codebase explained](https://supergraph.dev/internals.html)
[GraphJin codebase explained](https://graphjin.com/internals.html)

### Testing and Linting

Expand Down
Loading

0 comments on commit 10c1374

Please sign in to comment.