Skip to content

Postman-Student-Program/hacktoberfest21-website-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 

Repository files navigation

Postman API-First Hacktoberfest for Students: Website starter

<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, install instructions, how to run dev server etc.)
  • Any special contributing instructions
  • Project roadmap

Build a website that uses the Halloween Costume Contest API!

You have chosen to build a website!

Requirements

You can use ANY tech stack you like to build your website, as long as you deploy it.

Your website should fulfill at least these 5 user stories that consume the Halloween Costume Contest API:

- As a user, I can view all contestants' costume images in some kind of list
- As a user, I can view all details about a single contestant
- As a user, I can upvote individual contestants 
- As a user, I can add a contestant
- As an user on a secret page, I can delete contestants

You can of course add other features, such as a secret page for updating contestant details, or a map displaying where each contestant is from, etc.

The design is all up to you! Be creative and have fun 🎨😎

How to use the API

First, in Postman, fork this mock server we have prepared. It will allow you to make real API requests to get realistic fake data.

In Postman, a Mock Server is a real server that sends faked data. It allows frontend teams to write code that calls an API and gets realistic responses, without having to wait for the backend team to actually build the API! This is the API-First Way 😎

Getting started

1. Register for Postman's Student Hacktoberfest

Fill out this form

2. Fork this repo

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.

3. Add hacktoberfest topic to repo [optional]

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"

4. Clone your forked repo

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

Fork the Halloween Costume Contest API mock server in Postman

Fork this mock server collection to your own workspace.

Learn how to use Postman mockservers in this video:

Building your website

Make those pull requests!

When adding new changes and features to your website, 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:

Deploy your website

There are many solutions for hosting your website publicly for free. If you aren't sure which to use, try one of these:

See more free hosting solutions on this page

Submit your website

Submit this form once you've deployed a website that covers the 5 user stories.

We will check that your website covers the user stories, and enter you in the prize raffle! All completed projects will be featured in the Postman blog and Postman Student Newsletter.

Need help?

Get help in the Postman Student Community Discord server! Ask questions in the #hacktoberfest-frontend channel, or join us at Office Hours.

About

A starter repo for the website path of Postman's Student API-First Hacktoberfest

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors