<EDIT ME!>
README.md is a special file in your repo that gives an overview of your project - it is the landing page people see when they interact with your project. Write anything here that will help collaborators get started helping you! Feel free to replace this quote block with any explanation you want. Some things you might want to include:
- What the project is
- How to set up development environment (dependencies, local install instructions, how to run server etc.)
- Any special contributing instructions
- Project roadmap
You have chosen to build an API server 🎉! This server should allow users to create, read, update, delete, and upvote Halloween costume party contestants.
You can use ANY tech stack you want, as long your server matches the schema with 7 endpoints, and passes all the tests.
Endpoints:
- GET /
- GET /contestants
- GET /contestants/:id
- PATCH /contestants/:id
- DELETE /contestants/:id
- POST /contestants
- PATCH /contestants/:id/upvote
To see what types of responses your API should return, check out the schema or documentation.
Your API will need to pass the series of tests in this collection when run with the Collection Runner: Test collection
Fill out this form
Click the "Fork" button at the top-right of this repository. This will create a copy of the repo in your GitHub account.
*Note: if you are working in a team, only one person needs to fork this repo. That person will be the Maintainer. They can add teammates as collaborators on the repo.
If you would like anyone's pull requests in your repo to count toward DigitalOcean's Hacktoberfest, you will need to opt-in by adding the topic hacktoberfest to your repo.
In the "About" section in the upper-right of the repo, click the Settings icon. Add hacktoberfest to the Topics field, then click "Save Changes"
Clone the forked GitHub repo locally to your computer so you can start writing code.
You will need to have git installed on your computer
You can chose any tech stack you like. If you've never built an API before or want a quick start, you can use Postman's API code genereator feature (in Beta) to download a boiler of the server code based on the API schema.
You can do this in Postman for web to access the Beta feature.
In order to generate server boiler code, you will need to copy the API schema and create a copy of the API in your own workspace.
-
First, go to the Halloween Costume Contest API and select the version
0.0.1. -
Next click the Code Generation icon (
</>) in the far right menu
- Select the framework for generating your server boiler code
For more details see this page: How to generate server code in Postman
This will give you a place to start! You will still need to figure out how to persist data (for example by connecting a database).
In the API-First approach, a collection of test requests been created based off of the Halloween Costume Contest API schema.
You can fork the test collection in Postman to your own workspace. Then, update the baseUrl collection variable to the address of your API (ex: http://localhost:3000 for a local server, or https://my-deployed-api.herokuapp.com if deployed) and save.
Now when you run the collection runner on this collection, you will see which tests fail. The goal is to make all the tests pass by adding code to your project! This is called Test Driven Development (TDD).
Important: the tests should be run in the order given in order to work.
Use the collection runner to run the test collection against your API server. The goal is to get all of the tests to pass!
When adding new changes and features to your server, be sure to make new git branches. When you are ready to add these changes into the main project, you can push the changes to the main GitHub repo, and any of the repo Maintainers can approve it and merge it in.
If you are registered for Digital Ocean's Hacktoberfest, if 4 of your pull requests are approved in the month of October you are eligible to be sent a free limited edition T-Shirt.
If you are new to git, watch these videos to learn:
There are several solutions for deploying your API publicly for free. If you aren't sure which to use, try one of these:
If you are unable to deploy your API, that is OK. You can submit a video of your locally served API passing all the Postman tests in the Collection Runner.
Submit this form once you've deployed a website that passes all of the tests in the test collection.
You will need to provide the baseUrl of your deployed API server (if you were able to deploy it), so we can run the tests.
If you were unable to deploy your API, that is OK. You can submit a video link of running the tests in Postman's collection runner against your locally served project. Ensure that the video shows all of the tests passing.
We will check that your API passes all the tests, then enter you in the prize raffle! All completed projects will be featured in the Postman blog and Postman Student Newsletter.
Get help in the Postman Student Community Discord server! Ask questions in the #hacktoberfest-frontend channel, or join us at Office Hours.