Skip to content

mrodr359/ideas-board

Repository files navigation

🧠 Ideas Board API

Docker Flask License: MIT

A simple Flask-based API to submit, retrieve, and delete ideas β€” like startup ideas, reminders, or project concepts.
Data is stored locally using SQLite, and the project is containerized with Docker.


πŸš€ Features

  • Submit new ideas
  • Retrieve all submitted ideas
  • Retrieve a single idea by ID
  • Delete an idea by ID
  • Lightweight and fast
  • No external API or payment required

πŸ› οΈ Tech Stack

  • Python 3.12
  • Flask
  • SQLAlchemy (ORM)
  • SQLite (Database)
  • Docker

πŸ“¦ Getting Started

  1. Clone the repository:

    git clone https://github.com/YOUR-USERNAME/ideas-board.git
    cd ideas-board
  2. Install dependencies:

    pip install -r requirements.txt
  3. Run the application locally:

    python app.py
  4. Access the API at:

    http://localhost:5000
    

🐳 Run with Docker

  1. Build the Docker image:

    docker build -t ideas-board .
  2. Run the container:

    docker run -p 5000:5000 ideas-board

πŸ“‹ API Endpoints

Method Endpoint Description
POST /ideas Submit a new idea
GET /ideas Get all ideas
GET /ideas/{id} Get a single idea by ID
DELETE /ideas/{id} Delete an idea by ID

✨ Future Improvements

  • Add user authentication
  • Add categories/tags for ideas
  • Add pagination for large lists
  • Deploy to a public cloud platform

πŸ“ License

This project is licensed under the MIT License.


πŸ§‘β€πŸ’» Author

Created by Manny Rodriguez

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published