luckyframework / luckyframework/website

Write a tutorial guide on building a simple API

Open
#1,420 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Crystal
Stars
39
Forks
62
PR merge metrics
No merged PRs in 30d

Description

We have a tutorial already https://luckyframework.org/guides/tutorial/overview

but this covers building a full site. Doing a simple API alone could be a good alternative tutorial and should be a fairly simple app.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing tutorial at https://luckyframework.org/guides/tutorial/overview to understand its structure and how it builds a full site. Create a comparable tutorial for a simple API-only application; done means the guide is added to the Lucky website and provides a complete alternative tutorial.

Written by the indexing model from the issue text.

Assessment

Tech stack
crystal
Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.