mirror of
https://github.com/hoppscotch/hoppscotch.git
synced 2026-04-25 16:55:59 +03:00
[GH-ISSUE #1190] Kick off Hacktoberfest 👩💻👨💻👌 with the next best thing DEVs will ❤️ #409
Labels
No labels
CodeDay
a11y
browser limited
bug
bug fix
cli
core
critical
design
desktop
discussion
docker
documentation
duplicate
enterprise
feature
feature
fosshack
future
good first issue
hacktoberfest
help wanted
i18n
invalid
major
minor
need information
need testing
not applicable to hoppscotch
not reproducible
pull-request
question
refactor
resolved
sandbox
self-host
spam
stale
testmu
wip
wont fix
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
starred/hoppscotch#409
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @liyasthomas on GitHub (Sep 27, 2020).
Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/1190
Are you looking to contribute to an open source project in this Hacktoberfest? or want to get started with latest technologies like VueJS & NuxtJS?
We're developing Hoppscotch, an open source API request builder for the web, and would love to count you as a contributor to improve our components & applications.
Web app: hoppscotch.io
GitHub: @hoppscotch
24k+ stars on GitHub • # 2 product of the day on Product Hunt • featured in Indie Hackers, Hacker news, Hacker noon, YouTube & open source podcast etc.
Get started 🚀
As the project’s size grew quite a bit the past couple of months, you might ask yourself, where to get started 🤔?
Meet the technology stack:
Check out How to set-up Hoppscotch development environment in 5 mins →
1. Codegen
At Hoppscotch, we want to help developers to go from discovering an API to experimenting with it and then to make actually using the API in their code as frictionless as possible. To support that, Hoppscotch had the ability to generate code for JavaScript (XHR and Fetch API) and cURL. We recognize that a lot of devs of different backgrounds use Hoppscotch. So recently, we modularized and separated the code generation system (only for REST currently, WS and GraphQL coming soon!) into different code generator modules which can be easily added to and extended upon.
As a result now one can easily add code generation for multiple programming languages (and/or libraries, or even programs), even if you don't have much knowledge about the rest of the Hoppscotch codebase.
How to add your own code generator?
Step 1: Create a code generator object
Code generator objects are placed on
helpers/codegen/generatorsfolder, they have a specifiedid,name(display name) and a generator function which has a parameter,contextcontaining all the data about the request (refer, the existing generators to see which all data is available). The generator function should at the end return a string which is the final generated request code. The generator functions do not currently offer async support, but if you want async support, ping @AndrewBastin.Step 2: Register your new codegen object
Registration of the valid code generators are done through the
helpers/codegen/codegen.jsfile. Just import your codegen object in the file and add it to thecodegensarray.Once that is done, your code generator will be made available in the
Generate Codedialog as usual.Last step: run
npm run testto confirm all tests are passing with your addition.Any specific platforms ?
Although our goal is to eventually provide support for possibly all programming languages/libraries/programs. We would really love to see these platforms implemented.
Example contributions:
But even if it is not in this list, we would really love it to be included. So do not be discouraged. Please do make a PR for adding support to your platform of your choice.
2. i18n - Internationalization
View detailed instructions →3. Issues - Bugs and fixes
For the purpose of this first experience, we've have selected the issues tagged
#hacktoberfestwhich we're hoping to implement during this span on a month.Here are some issues/feature requests to start with:
Check out the issues tab for more 😋 or alternatively you can create new features (and prolly PRs 😉) or optimize any existing functions/routines.
4. Tests
If you're interested in writing tests, contribute to our test cases. We're using Jest for testing. Ping @AndrewBastin for any help.
5. Beta testers
If you have general feedback, please reply here.
View detailed instructions →Feel free to ping us on Discord or Telegram for any help.
Cherry on the cake 🍒🎂
Beside unlocking some karma points, you know what would be cool with your contributions 🤔? All the improvements you'll submit will not only have effect to the components, but also they'll have an impact on open source dev community & be included in our live platform used by 80k+ users. Kind of cool to know that something you would develop will for sure be available in an online live application! isn’t it?
Hacktoberfest 🐙
Support open source and pick a limited edition T-shirt 👕 or plant a tree! 🌱
Rules:
To qualify for the official limited edition Hacktoberfest shirt, you must register and make four pull requests (PRs) between October 1-31 (in any time zone). PRs can be made to any public repo on GitHub, not only the ones with issues labeled Hacktoberfest. This year, the first 70,000 participants who successfully complete the challenge will earn a Hacktoberfest tee or plant a tree.
Happy hacking ❤️
If you've read this far, thank you for taking time out to participate ❤️. Feel free to ping @liyasthomas / @AndrewBastin for any help.
@luthrap commented on GitHub (Oct 4, 2020):
I can pick up code generator for python
@AndrewBastin commented on GitHub (Oct 4, 2020):
Go for it @luthrap
@liyasthomas commented on GitHub (Oct 6, 2020):
Hi @luthrap , Python Requests codegen has been contributed by @yq314 on #1244. You can look into
Python http.clientcodegen. Happy hacking.@luthrap commented on GitHub (Oct 7, 2020):
sure, will pick http.client
@shalika10 commented on GitHub (Oct 9, 2020):
Hey i want to pick code generator for java ,please assign it to me
@liyasthomas commented on GitHub (Oct 9, 2020):
@shalika10 go for it 👌
@piraces commented on GitHub (Oct 9, 2020):
Hey, can I take the
shellwithwgetgenerator?@liyasthomas commented on GitHub (Oct 9, 2020):
@piraces yeah sure ✨
@Ldoppea commented on GitHub (Oct 9, 2020):
Hi,
I would like to try implementing the C# one. Did someone already start to work on it?
@liyasthomas commented on GitHub (Oct 9, 2020):
@Ldoppea you can work on C# codegen.
@Ldoppea commented on GitHub (Oct 9, 2020):
Great, i'll do it this week end 😃
@florinmirosnicencu commented on GitHub (Oct 12, 2020):
I want to pick up the codegen for pecl_http (PHP)
@guptajyoti845 commented on GitHub (Oct 14, 2020):
Hello I want to pick code generator for nodejs unirest, please do assign to me
@liyasthomas commented on GitHub (Oct 14, 2020):
@guptajyoti845 go for it 👍
@silentmatt commented on GitHub (Oct 17, 2020):
For HTTP, are you looking for the raw text that would be sent in the request? i.e. something like
@mrkunal commented on GitHub (Oct 20, 2020):
Hello I want to pick code generator for java unirest, please do assign to me
This is my first issue
@liyasthomas commented on GitHub (Oct 20, 2020):
@mrkunal go for it 🚀
@patidar-jaishree commented on GitHub (Oct 29, 2020):
Hey I want to pick code generator for C (LibCurl) ,please assign it to me
@liyasthomas commented on GitHub (Nov 2, 2020):
Hi hackers,
Thank you so much for the all #Hacktoberfest contributions 🎃🎉
Keep contributing to open source 👋👋