A collection of useful tools in the train hacker area.
Make sure you have a recent version of Node.js installed (we recommend at least version v12.14.
). After installing Node.js you'll have the node
but also the npm
command available. npm is Node.js' package manager.
Additionally, please have a look at the CONTRIBUTING.md including further information about what counts as a bahn helper.
Fork and clone this repository. Head over to your terminal and run the following command:
git clone [email protected]:[YOUR_USERNAME]/tiny-helpers.git
cd tiny-helpers
npm ci
npm run projects:add
Under projects you find the project-name.json-files. Copy and add the information in your style
{
"name": "My Project",
"desc": "",
"url": "my-url.org/",
"links": {
"github": "https://github.com/xxx"
},
"licenses": [
"MIT"
],
"contacts": [
],
"maintainers": [
],
"addedAt": "2020-12-12"
}
npm run projects:add
will ask a few questions and create a file in helpers/
.
Commit the changes and open a pull request.
This project uses Vercel's routing configuration. The /
route doesn't work locally. To start, navigate to localhost:8080/home/
after running npm run dev
.
npm run dev
Inspired by the project https://tiny-helpers.dev/ from Stefan Judis.
Stefan Judis |