How to Submit Completed Project Examples to the App Ideas Repository

To submit a completed project example to the florinpop17/app-ideas repository, fork the project, create a feature branch, add a markdown file following the Example Guide template, and open a Pull Request against the master branch.

The florinpop17/app-ideas repository maintains a curated collection of coding project specifications alongside real-world implementations. When you complete one of the listed applications, you can submit your work to help other developers reference a working implementation. This contribution process requires creating structured documentation that links to your live demo and source code.

Fork and Clone the Repository

Begin by creating your own copy of the repository. Navigate to florinpop17/app-ideas on GitHub and click Fork to create a personal copy under your account.

Clone your fork locally and create a dedicated branch for your submission. Use a descriptive name that indicates which project you are adding:

git clone https://github.com/your-username/app-ideas.git
cd app-ideas
git checkout -b add-example-todo-app

Create the Example File

Navigate to the appropriate project directory within Projects/<tier>/<Project-Name>/. Create a new markdown file for your example implementation. According to the Example Guide (Example Guide.md), your file must include the tier level, description, live demo link, source code URL, and a checklist mapping your features to the original specification.

Here is the standard template structure:

# To‑Do App – Example Implementation

**Tier:** 2‑Intermediate  
**Description:** A full‑stack version of the To‑Do App built with React, Node.js, and MongoDB.

## Live Demo

[https://todo-example.fl0.com](https://todo-example.fl0.com)

## Source Code

https://github.com/your‑username/todo‑example

## Features Implemented

- Add, edit, delete, and filter tasks
- Persistent storage with MongoDB
- Responsive UI with Tailwind CSS

## How it maps to the original spec

- ✅ User can create a new task
- ✅ User can edit an existing task
- ✅ User can delete a task
- ✅ User can filter tasks by status

---

*This example follows the [Example Guide](./Example%20Guide.md) layout.*

Save this file using a clear naming convention such as Projects/2-Intermediate/To-Do-App/Example-Implementation.md.

Update the Project Documentation

Optionally, update the main project markdown file to reference your new example. Open the existing project file (e.g., Projects/2-Intermediate/To-Do-App.md) and locate the Example projects section. Add a bullet point that links to your new example file to improve discoverability.

Submit Your Pull Request

Commit your changes with a clear, descriptive message:

git add .
git commit -m "Add example implementation for To‑Do App"
git push origin add-example-todo-app

Open a Pull Request against the upstream master branch. Ensure your PR follows the guidelines defined in CONTRIBUTING.md, which specifies the contribution checklist and style requirements. Reference any related issues in your PR description to help maintainers understand the context.

Once submitted, the repository maintainer will review your example against the Example Guide standards. After approval and merging, your implementation will appear in the project's Example projects section as listed in the main README.md.

Summary

• Fork and branch: Create a personal fork and a descriptive feature branch (e.g., add-example-project-name).
• Follow the template: Use the structure defined in Example Guide.md located in the repository root.
• File location: Place examples in Projects/<tier>/<Project-Name>/ directories.
• Commit and push: Use clear commit messages and push to your fork.
• Target master: Open Pull Requests against the master branch per CONTRIBUTING.md.
• Link your work: Include live demos and source code URLs in your example file.

Frequently Asked Questions

What is the Example Guide in the App Ideas repository?

The Example Guide (Example Guide.md) is a template document that defines the exact markdown structure required for submitting project examples. It specifies required sections including the tier level, description, live demo link, source code reference, and a mapping checklist showing which original specification requirements your implementation satisfies.

Do I need to update the main project README when adding an example?

Updating the main project README is optional but recommended. The README.md file contains an Examples section that explains the contribution process, while individual project files in Projects/<tier>/<Project-Name>.md contain the Example projects section where you should add a reference link to your new example file for better visibility.

What branch should I target when submitting a Pull Request?

You must open your Pull Request against the upstream master branch. The CONTRIBUTING.md file specifies that all contributions should target master, and your PR must pass the contribution checklist outlined in that document before it can be merged.

Can I submit multiple project examples in one Pull Request?

While technically possible, it is better practice to submit one example per Pull Request. This allows maintainers to review each implementation individually against the Example Guide.md standards and ensures cleaner git history. If you have multiple examples, create separate branches and PRs for each submission.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}