Popcode is the official editing environment for the Code Nation Intro to Web Development program in the 2019–2020 school year.
The validation system is the main point of this project. Most syntax checkers, linters, and style enforcers tend to provide feedback using language that is geared toward experienced coders, not beginners. Thus, providing a translation of error messages into plain English for students is the overriding concern of this project.
Popcode tends toward strict enforcement of lint and code style, even when enforced style decisions are arbitrary, under the philosophy that giving students one right way to do it eliminates ambiguity and aids the learning process.
Popcode is an all-volunteer project and contributions are welcome. I encourage first-time contributors to start with the Getting Started guide, which gives a friendly and detailed breakdown of each step toward contributing your first pull request.
This will install
yarnin an isolated environment in the
nodeenvdirectory of the project root. It won’t interfere with any system-wide installation of those tools.
Once setup is complete, to run a development server, run:
$ tools/yarn.py start
This will start a server on http://localhost:3000
To start tests in watch mode, run:
$ tools/yarn.py autotest
package.jsonfor other useful tools.
Popcode comes with a robust custom VS Code configuration, which is automatically enabled by
tools/setup.py. If you use VS Code, you can:
Show Recommended Extensionscommand to easily install extensions that improve the Popcode developer experience
taskinto the Quick Open bar to autocomplete the task to run
debuginto the Quick Open bar
tools/yarn.py lintfixbefore committing to format and autofix lint. Popcode’s official VS Code integration (with recommended extensions installed) does this out of the box.
There is no requirement that you use the official development environment to work on Popcode; you’ll mostly just need the right versions of Node and Yarn installed on your machine (check the
package.jsonfor the current versions).
Popcode endeavors to use up-to-date technologies and code conventions to make development as pleasant as possible. Below are links to reference documentation on the major tools:
Popcode is distributed under the MIT license. See the attached LICENSE file for all the sordid details.
These companies generously offer Popcode access to paid tiers of their excellent services, free of charge:
Feel free to email me at [email protected] if you have any questions.
You can find our Slack team, including our #dev channel, here.