|
1 | | -<h2 align="center">Opinionated Gatsby Starter</h2> |
| 1 | +<h2 align="center">twoeyes</h2> |
2 | 2 |
|
3 | 3 | <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> |
33 | 8 | <a href="https://github.com/prettier/prettier"> |
34 | 9 | <img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"></a> |
35 | 10 | </p> |
36 | 11 |
|
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. |
38 | 21 |
|
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. |
40 | 26 |
|
41 | | -Supports: |
| 27 | +#### ↗ Motivation |
42 | 28 |
|
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. |
62 | 30 |
|
63 | | -## 🚀 Quick start |
| 31 | +#### ? Instructions |
64 | 32 |
|
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. |
66 | 36 |
|
67 | | - Firstly, you need to install Gatsby CLI on your machine: |
| 37 | +Try to close your eyes one by one for better understanding. |
68 | 38 |
|
69 | | - ```shell |
70 | | - $ npm i -g gatsby-cli |
71 | | - ``` |
| 39 | +#### ⤓ Installation |
72 | 40 |
|
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. |
74 | 46 |
|
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". |
79 | 50 |
|
80 | | -1. **Start developing.** |
| 51 | +#### ⛒ Offline mode |
81 | 52 |
|
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. |
83 | 56 |
|
84 | | - ```shell |
85 | | - $ cd opinionated-project/ |
86 | | - $ npm i -D husky |
87 | | - $ npm run start |
88 | | - ``` |
| 57 | +### ⥅ Contributions |
89 | 58 |
|
90 | | -## 🎓 Learning Gatsby |
| 59 | +I am open to contributions mainly as exercises as for example: |
91 | 60 |
|
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 |
93 | 64 |
|
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 |
95 | 66 |
|
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> |
97 | 96 |
|
98 | | -### 💫 Deploy |
| 97 | +### 💫 Deploy your own |
99 | 98 |
|
100 | | -[](https://app.netlify.com/start/deploy?repository=https://github.com/datacrafts-io/gatsby-opinionated-starter) |
| 99 | +[](https://app.netlify.com/start/deploy?repository=https://github.com/cxspxr/twoeyes) |
101 | 100 |
|
102 | | -[](https://vercel.com/import/project?template=https://github.com/datacrafts-io/gatsby-opinionated-starter) |
| 101 | +[](https://vercel.com/import/project?template=https://github.com/cxspxr/twoeyes) |
0 commit comments