Pull the package down. Forgive the cruft. Make awesome new things!
"New things" could be:
- An "article" that is on-topic. Or off topic? We don't know.
- A poem or other collection of adjacent words.
- A game!
- A quiz!
- Clickbait!
- A pyramid scheme!
- A site forum.
- Upgraded old content (from the
archivefolder) - Things you just want to try, but don't have any other good place to try them!
- And almost literally anything you can think of.
You're lookin' at it. Just fork it and go git your fork.
If you don't have node, (including npm), you'll need to install it.
To install deps and start your local dev server:
npm i && npm run start
Or, if you have yarn installed:
yarn && yarn start
This should start the site on localhost:9999 and automatically open it in your default browser. Changes you make to the source (in src) will automatically trigger a rebuild. There's no auto-refresh in the browser. (Click the refresh button to see your changes.)
When you're satisfied with your work, commit it, push it, and submit a PR.
We're deployed and hosted with AWS Amplify, and built on wirejs-dom. We use yarn to get things done. And webpack for builds.
We don't have any of Amplify's wonderful backend integrations enabled yet. But, the plan is to do so. We'll get there when we get there.
If you have an idea that depends on some backend stuff and can explain what resources you need, submit an issue. If your idea isn't terrible, we'll try to make time to get your resources set up.
You're welcome to submit small or isolated changes against master.
Large, complex, or "risky" pull requests can be submitted against the dev branch. The dev branch is published to dev.thepointless.com. This allows for some testing extended QA prior to promotion to production.
You can log into dev.thepointless.com with:
Username: dev
Password: devpassword| Folder | Purpose |
|---|---|
| /amplify | files used by the aws amplify framework for back-end services and hosting |
| /archive | files from the pre-aws migration, php version of site. pull requests to migrate this content will generally be welcome and appreciated. |
| /dist | built files. not to be added to the repository. |
| /node_modules | node modules, managed by npm; not by you. |
| /scripts | CLI scripts that may be used during development, building, etc.. |
| /src | content and script that must be "built" for deployment |
| /src/components | wirejs-dom web components intended to be used across pages |
| /src/layouts | top-level layouts into which route content (.md and .html files) are embedded. |
| /src/lib | common javascript modules that are not wirejs-dom components |
| /src/routes | routable paths. .md and .html files herein produce human-navigable URLs. |
| /src/routes/apps | Stand-alone apps. Generally inteded for installable PWA's, specifically. |
| /src/routes/hs | Horoscopes and other interactive-ish things that a High School girl might be inerested in, like personally tests. |
| /src/routes/words | Words-focused stuff. Writing. Silly or not. |
| /static | content that will be deployed as-is. |
| /static/images | images that are deployed statically, as-is. |
We don't have any documented rules just yet. Just try to follow the patterns from the non-archived content, components, and service wrappers. Be receptive to feedback during PR's. We will try not to be terrible, but we reserve the right to steal ideas from your PR's and publish them as our own if you're unable to reasonably closely conform our patterns, etc..
And, that's important or two reasons. Firstly, we are potentially the most important dot-com on the planet. Having your name in our git log is super cool.
But secondly, we try to share the wealth with folks in our git log. (Admittedly, not much wealth at the moment ... but, we're getting there!)
And so ...
You can also contribute by submitting and commenting on issues.
- Ideas for new pages / features
- Bug reports
- Asking for help with the development process
- Saying "Hi."