Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Private Opening party ! #6

Open
hugolpz opened this issue Apr 5, 2021 · 2 comments
Open

Private Opening party ! #6

hugolpz opened this issue Apr 5, 2021 · 2 comments

Comments

@hugolpz
Copy link
Owner

hugolpz commented Apr 5, 2021

Hello @kanasimi, welcome on WikiapisJS's Eggs ! πŸ₯š πŸ‰ The demo kickstarter project for WikiapiJS.

This project is still a draft. The README.md is still messy and more advanced Β« eggs Β» are still missing, but it will get better and broader. I picked the code from either the current Wikiapi's README or from my Dragons Bot. But the eggs have not been tested (ran). These eggs, when given proper love, can become powerful beasts as the developer's intends.

I don't put timeline on this project tho. We just did a massive pushes on Wikiapi documentation and about 20 issues within a month or so. It's an open source project, for pleasure, it is seeded here on Github and won't move away. We can return here and edit forward when we feel to.

Project philosophy : teaching approach
This project's code is very much teaching oriented and amateur-developers-friendly. Target public are the highly active Wikimedians with quite limited JS skills, who need to mass do things. They can follow instructions, install NodeJS and hack codes, but have quite limited knowledge of JS syntax, debugging, dev tools and co. They can hack codes but barely expand or maintain them in case of error.
The project is also good for more skilled developers, like me or above, who can take over, pick up quickly, user Wikiapi's JSdoc3 documentation, and build more advanced tools. It's a kick starter to onboard folks. It will naturally brings people to WikiapiJS. 😎

Notes on recent changes
Following on that philosophy, I'am considering restoring this more explicit code :

var USER = logins.commons.user_name,
      PASS = logins.commons.password,
      API = logins.commons.API_URL;
await targetWiki.login(USER, PASS, API);

I'am also considering using in-file data :

var data = [
    { letter: 'a', filename: 'a-red.png', author: 'Beyoncey' },
    { letter: 'b', filename: 'b-red.png', author: 'Beyoncey' },
    { letter: 'c', filename: 'c-red.png', author: 'Shakiraa' },
    { letter: 'd', filename: 'd-red.png', author: 'Beyoncey' },
    { letter: 'e', filename: 'e-red.png', author: 'Queen Elisabeth II' },
    { letter: 'f', filename: 'f-red.png', author: 'Beyoncey' },
];

Rather than external data

const data = require('./data/letter.js');

And ./data/letter.js :

module.exports = [ ... ];

You see the idea. It's now good coding practice, but such clarity has teaching, on-boarding purposes. πŸ€”

@kanasimi
Copy link
Collaborator

kanasimi commented Apr 5, 2021

Just do it!

@hugolpz
Copy link
Owner Author

hugolpz commented Apr 5, 2021

😎 πŸ‘πŸΌ #likeThat. Need a 3 weeks break on my side tho.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants