Use of this starter template assumes that you have a 'complete dev environment' setup - a terminal, Node, VS Code, at least. If not, you may want to start here.
- Click that big green button to start using it.
cloneyour new repo from your GitHub to your local computercdinto thecloned repo and enter:npm i.
. I have adjusted this slightly as per this
commit. More may be forthcoming as feedback and PRs trickle in.huskyis also there to help check over code quality with the linters b4 there is a successfulcommit.webpackto allow the use of modern EcmaScript Modules- Various VS Code 'settings' and 'extensions.' Look in the bottom right when you open this up in VS Code to install them.
- Kite 🪁 is also included. I personally recommend it, but it's certainly not compulsory to set this up.
- Directories 📂 with 'index.js' files as a suggested architecture. See comments in those files for addl. info.
Run npm i to get all the things installed.
Ideally, you'll run this from 2 different terminal instances.
In one terminal, you do: npm run webpack. This will watch the files in src. This is where you would do your coding.
In the other terminal: npm start. This will execute the dist/main.js that webpack builds for you.
Essentially, you just code and if you've set all the things up correctly, you will get alerted whenever there is something 'bad' in your code based on some industry-standard best practices 🦄.
Don't 4get to drink your Ovaltime update "name", "description", "author", etc. in 'package.json' when using this for your stuff.
['webpack.config.js'] is configured to allow 'absolute imports.' This means that, for example in 'index.js,' you could do: import api from "api";, w/o worrying about ../ spit. If you end up removing 🔥 directories 📂, you may need to also see the 'TODO' in '.eslintrc.js'
Note that you may still see warnings about 'unsresolved imports' as 'ES Lint' is not able to tell that we have 'webpack' taking care of 'absolute' imports. To avoid this, see here
- For fonts, I set 'Victor Mono' by default. You might also install: 'Inconsolata' or 'Source Code Pro' - or completely change that in .vscode/settings.json, if you know what you are doing!
⚠️ - As you get more comfortable, of course you can modify all the things as you C fit.
- Read more about the motivations behind this here.
Use the 'comments' section of the Dev post for ❓s or discussion.
If it's an actual issue... open 1.
Contributions welcome. No specific guidelines at this point - just common sense - specific tasks, good commit messages, etc. Feel free to LMK of any doubts or queries.
I do prefer commit messages that use gitmoji. Also, using those sort of helps with 'categorizing' and 'separating' commits appropriately.