This Hacktoberfest we are mixing it up - YOU get to create and maintain an open source repo (or work together with friends).
The challenge will be to build either an API or a website that consumes the API. The interface for the API has already been designed: it is a Halloween Costume Contest API, that allows you to create, read, update, delete and upvote costume party contestants.
See the OpenAPI schema for this API in the "API" tab: Show me the schema!
API-First is the philosophy putting APIs at the foundation of your strategy. This includes defining an API before writing any code for a server or frontend. The endpoints, parameters, responses and other traits of an API can be clearly defined with a schema. You can think of a schema as a blueprint for an API.
With a schema as a single source of truth, teams can move quickly with a “divide and conquer” approach to building applications. For example, frontend developers can code a website that hits a mock server that returns fake data of the expected shape, without having to wait for the backend team to build a real server. Meanwhile, the backend team can start coding a server against tests that check that the API schema is being implemented correctly.
There are several specification formats for defining an API schema. One is called OpenAPI Specification (previously known as Swagger), which we are using in this event to define the Halloween Costume Contest API!
Postman provides you with the tools you need to develop with an API-First approach. From an API schema, you can auto-generate mock servers, tests, documentation, and even server code. See more about how Postman can help you drive an API-First development lifecycle here.
- Must be a student, or graduated but not yet working
- Must submit either an API or a website by the end of October
- Must follow our Code of Conduct
Sign up with this form. This will keep you in the loop with workshop accouncements and updates!
DigitalOcean hosts this event each year and awards limited edition T-Shirts to applicants who make 4 pull requests during the month of October.
* Note: T-Shirts available only for the first 50,000 participants
Do you want to build an API or a Website? 👀
Pick one and find instructions and requirements in these starter repos:
=> I want to build an API (backend)
=> I want to build a Website (frontend)
* if you are planning to work on a team, only one person needs to fork the starter repo. This person will become the repo Maintainer
Submit your repo here, once you've completed building an API or Website that meets the requirements!
If a repo had multiple contributors, each contributor should submit the same repo separately.
| Title | Dates and Times |
|---|---|
| Hacktoberfest Kickoff | October 5, 2021, 9am - 10am PST |
| Discord Office Hour IST | Thursdays, 8pm - 9pm IST |
| Discord Office Hour PST | Wednesdays, 10:00am - 11:00am PST |
| Postman Submission Deadline | Anytime on October 31 |
One repo that meets the challenge requirements will be chosen by raffle to win a $250 amazon gift card. This money can be split among contributors.
If you finish the challenge, you will have:
- a portfolio piece
- learned how to use Postman for API-First development
- experienced open source software development!
Join our Postman Student Community Discord for office hours, general help and fun if you haven’t already!