kshitij10496/hercules

Render the landing page for API v1

Open

#27 opened on Oct 20, 2018

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Go (18 forks)auto 404
easyenhancementgood first issuehacktoberfestserver

Repository metrics

Stars
 (35 stars)
PR merge metrics
 (PR metrics pending)

Description

We now have a landing page listing all the API endpoints currently implemented in v1. All thanks to #19 by @rasfa98 ! 😃

Next step would be to integrate it in the API and render the static HTML page on /api/v1.

References: [1]: https://stackoverflow.com/questions/26559557/how-do-you-serve-a-static-html-file-using-a-go-web-server

Contributor guide

Research direction
Learn how to serve static files using Go's net/http package. Specifically, use http.FileServer and http.StripPrefix to serve the HTML file at /api/v1.
Tech stack
go
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85