Giter VIP home page Giter VIP logo

snippetpoems's Introduction

Snippet Poems

A digital magnet poetry board for creative idea generation.

Deployed Link

Deployed Snippet Poems link

Project Trello Board & User Stories

Trello Project Board

App Vision

It is a place for creative associations with a generated theme. Users could use this as a poetry app or a place to organize associated thoughts. It should be a place to have fun with little distraction. Users should be able to save, update, and delete their own poems. They should also be able to use custom themes generated on the spot with Open AI.

App Objectives Addressed

  • the challenge of idea generation in a clutter-free environment
  • the need for an interactive and enjoyable method of organizing thoughts
  • the desire for a customizable creative outlet

Versions & Updates

Future Updates Planned

  • Fix toasts
  • Make board operable with arrow keys and enter buttons
  • Make board and tiles easier to read with screen readers
  • Allow users to see and use themes saved to their profile in the database
  • Allow customization of user poem gallery theme
  • Add loading functions

Version 3 (current)

12-20-23

  • UI changes after feedback from beta tester/ dev associate
  • Toasts added for async requests
  • Github login functioning
  • Google login functioning with many, many warnings for the user
  • Notification box added to show selected tile, selected square, & board-related information to the user
  • State updated for toast functions
  • Feedback given to user on every part of the application
  • Formatting changes for UI & CSS updated.
  • README updated & Requirements.md added

Version 2

12-15-23

  • Changes everything to functional components & useState.
  • Different requests and rendering.
  • npm ERR! notsup Unsupported platform for [email protected]: wanted {"os":"darwin"} (current: {"os":"linux"}) -- switched it to "darwin", "os", "linux"
  • Updated UI for splitting words
  • Requests of all kinds work locally
  • App almost complete... just need to double check everything and fix deployments

Version 1

12-10-23

The Magnet Board page is set up, along with basic information about the dev (me) and the application. There is a route for the Profile page. UI buttons set up for saving boards to the database. There is logic for selecting a square in the UI.

Still to do for MVP:

  • Set up selecting tile in the UI & Alerts
  • Set up Auth0
  • Set up paths to individual database
  • Render poems on Profile page for the user
  • Make a route back to the Magnet Board page to make changes to that board.

Languages

Please see package.json for detailed versions.

Languages: React/Vite, Node, CSS, Tailwind, Javascript, Mongoose, Express, Cors

Services: OpenAI API, Netlify, Render, MongoDB Atlas

Domain Model

Domain model

Database Model

Server DB Model (1)

Wireframe

WireFrame

Usage Notes (!)

The generated themes are made to Open AI, but this is a lowest-tier-available level of service that I am using for development on this application. It's possible that I may exceed my limit of tokens for my subscription rate or financially as a budding dev, so the "Generate Theme" function is subject to that possibility. Thank you for your consideration.

snippetpoems's People

Contributors

maddieamie avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.