Skip to content

Commit 72e1fc9

Browse files
authored
Merge branch 'master' into renovate/eslint-7.x
2 parents a5c593f + f2fe40b commit 72e1fc9

21 files changed

+2856
-1607
lines changed

README.md

Lines changed: 76 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,101 @@
1-
<h2 align="center">Opinionated Gatsby Starter</h2>
1+
<h2 align="center">twoeyes</h2>
22

33
<p align="center">
4-
<em>
5-
TypeScript
6-
· jest
7-
· testing-library
8-
· Storybook
9-
</em>
10-
<br />
11-
<em>
12-
ESLint + airbnb
13-
· stylelint
14-
· remark-lint
15-
· Prettier
16-
</em>
17-
<br />
18-
<em>
19-
Netlify-ready
20-
· GitHub Actions
21-
· Renovate
22-
· TypoCI
23-
· PWA-enabled
24-
· Typography.js
25-
</em>
26-
</p>
27-
28-
<p align="center">
29-
<a href="https://github.com/datacrafts-io/gatsby-opinionated-starter/actions?query=workflow%3AMain+branch%3Amaster">
30-
<img alt="Github Actions Build Status" src="https://img.shields.io/github/workflow/status/datacrafts-io/gatsby-opinionated-starter/Main?label=Build&style=flat-square"></a>
31-
<a href="https://www.npmjs.com/package/gatsby-opinionated-starter">
32-
<img alt="npm version" src="https://img.shields.io/npm/v/gatsby-opinionated-starter.svg?style=flat-square"></a>
4+
<a href="https://app.netlify.com/sites/twoeyes/deploys">
5+
<img src="https://api.netlify.com/api/v1/badges/8994a6ec-7f8e-44c3-96ee-8a245381feba/deploy-status" alt="Netlify Status"></a>
6+
<a href="https://github.com/cxspxr/twoeyes/actions?query=workflow%3AMain+branch%3Amaster">
7+
<img alt="Github Actions Build Status" src="https://img.shields.io/github/workflow/status/cxspxr/twoeyes/Main?label=Build&style=flat-square"></a>
338
<a href="https://github.com/prettier/prettier">
349
<img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"></a>
3510
</p>
3611

37-
### _Very_ opinionated starter for Gatsby
12+
### 👁 Binocular trainer
13+
14+
This piece of software serves as a helpful tool to restore
15+
a binocular vision.
16+
17+
#### ⚠ Caution
18+
It is not in any way official treatment and nobody doesn't pretend it is.
19+
It just what helps me (along with exercises) to deal with my problem,
20+
thus I wanted to share it.
3821

39-
This is a complex boilerplate for [Gatsby](https://www.gatsbyjs.org/).
22+
If you have strabismus or amblyopia you need to deal with them first.
23+
Consult your doctor for that matter or at least do as many eye exercises
24+
as you could, because it would be really hard to make use of these exercises
25+
otherwise.
4026

41-
Supports:
27+
#### ↗ Motivation
4228

43-
- [TypeScript](https://www.typescriptlang.org/)
44-
- [Renovate](https://renovate.whitesourcesoftware.com/)
45-
- [PWA](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps)
46-
- [PropTypes](https://github.com/facebook/prop-types)
47-
- [Storybook](https://storybook.js.org/)
48-
- [Typography.js](https://kyleamathews.github.io/typography.js/)
49-
- [Jest](https://jestjs.io/)
50-
- [testing-library](https://testing-library.com/)
51-
- [stylelint](https://stylelint.io/)
52-
- [ESLint](https://eslint.org/)
53-
- [Airbnb ESLint config](https://github.com/airbnb/javascript)
54-
- [Prettier support for ESLint](https://github.com/prettier/eslint-plugin-prettier)
55-
- [remark-lint](https://remark.js.org/)
56-
- [Husky](https://github.com/typicode/husky)
57-
- [TypoCI](https://typoci.com/)
58-
- [SCSS](https://sass-lang.com/)
59-
- [(S)CSS Modules](https://github.com/css-modules/css-modules)
60-
- [Netlify](https://www.netlify.com/)
61-
- [GitHub Actions CI](https://github.com/features/actions)
29+
There is ***really*** not so many applications that helps with that exact problem.
6230

63-
## 🚀 Quick start
31+
#### ? Instructions
6432

65-
1. **Create a Gatsby site.**
33+
The main thing about exercises is that you need to try to either
34+
see the both colors darkly or both colors brightly, that would be
35+
the indicator that both eyes work.
6636

67-
Firstly, you need to install Gatsby CLI on your machine:
37+
Try to close your eyes one by one for better understanding.
6838

69-
```shell
70-
$ npm i -g gatsby-cli
71-
```
39+
#### ⤓ Installation
7240

73-
Use the Gatsby CLI to create a new site, specifying a starter.
41+
It is possible to install the application on desktop and
42+
mobile. For that matter one would need a modern [Chrome browser](https://www.google.com/chrome/).
43+
Then when you open the website, there should be either **** sign next
44+
to the address line or the popup that suggest you to add an app to either desktop
45+
or to the home screen of your mobile device.
7446

75-
```shell
76-
# create a new Gatsby site using this starter
77-
$ gatsby new opinionated-project https://github.com/datacrafts-io/gatsby-opinionated-starter
78-
```
47+
In any case it is possible to install the app by clicking on
48+
[***Customize and control Google Chrome***](https://www.live2tech.com/wp-content/uploads/2018/02/how-to-home-button-google-chrome-1.jpg)
49+
context menu toggle and then clicking something like "Add to home screen".
7950

80-
1. **Start developing.**
51+
#### ⛒ Offline mode
8152

82-
In order to run Storybook + Gatsby dev server, navigate into your new site’s directory and start it up.
53+
The application works fully offline once you are visited
54+
the website, and you will receive updates once something
55+
is updated, in case you use the officially deployed application.
8356

84-
```shell
85-
$ cd opinionated-project/
86-
$ npm i -D husky
87-
$ npm run start
88-
```
57+
### ⥅ Contributions
8958

90-
## 🎓 Learning Gatsby
59+
I am open to contributions mainly as exercises as for example:
9160

92-
Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
61+
* 2D (mini-) games written in React
62+
* Physics simulations in React / react-three-fiber
63+
* Interactive graphics in react-three-fiber
9364

94-
- **For most developers, it is recommended starting with official [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
65+
### ⚙ Technologies used
9566

96-
- **To dive straight into code samples, head [to official documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
67+
<p align="center">
68+
<em>
69+
React
70+
· GatsbyJS
71+
· three.js
72+
· react-three-fiber
73+
· TypeScript
74+
</em>
75+
<br />
76+
<em>
77+
ESLint + airbnb
78+
· stylelint
79+
· remark-lint
80+
· Prettier
81+
</em>
82+
<br />
83+
<em>
84+
jest
85+
· testing-library
86+
· enzyme
87+
</em>
88+
<br />
89+
<em>
90+
GitHub Actions
91+
· Renovate
92+
· TypoCI
93+
· PWA
94+
</em>
95+
</p>
9796

98-
### 💫 Deploy
97+
### 💫 Deploy your own
9998

100-
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/datacrafts-io/gatsby-opinionated-starter)
99+
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/cxspxr/twoeyes)
101100

102-
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/datacrafts-io/gatsby-opinionated-starter)
101+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/cxspxr/twoeyes)

gatsby-config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
module.exports = {
22
siteMetadata: {
33
title: "twoeyes",
4-
description: "Binocular trainer",
4+
description: "Binocular trainer. Restoring binocular vision by exercising",
55
author: "Yaroslav Kasperovych",
66
},
77
plugins: [

0 commit comments

Comments
 (0)