Giter Site home page Giter Site logo

souperb's Introduction

SOUPerb

SOUPerb is an app that will let you store all your recipes in one easy to use place. This full-stack application uses RESTful routes and MVC framework. You can skip creating an account by using the logins below:

  • Username: Souperb
  • Password: SoupMail1

๐Ÿฒ How to use

  • You can sign up via the "sign up" CTA, then proceed to login.
  • Click on "Create a recipe"
  • Enter the relevent information, you can include a source as well as an image.
  • Select the relevent categories and click "Create".
  • Your recipe has now been added and can be found on the homepage via the categories section.
  • You can edit the recipe as you please, as well as remove them entirely.

๐Ÿณ Try it out

๐Ÿ” Sign up feature

  • Case sensitive and unique usernames
  • Email validator
    • Include one @
    • One character before @
    • Include at least one dot after @
    • One character between @ and .
    • At least one character after .
  • Password validator
    • Minimum 8 characters long
    • At least one uppercase character
    • At least one number

๐Ÿ› ๏ธ Technology used

  • HTML/CSS
  • Ruby
  • Sinatra
  • PostgreSQL

๐Ÿ“ Planning

  • Created a database flowchart showcasing all the information that is needed as well as data type
  • Created a website flowchart to help visualise RESTful routes
  • Created the database and pre-planned most PSQL queries
  • Researched recipe websites and food apps
  • Designed a rough website mockup with Adobe PS

๐Ÿ› Bugs

  • N/A

๐ŸŒฑ Future updates

  • Add a couple of automatic recipes for every user so when signed in, the page isnt empty
  • Add a user show and edit page/functionality
  • Add search functionality
  • Add recipe tags where users can input their own tags (eg: eggplant, gluten free)

๐ŸŽจ Digital Mockups

Mockup created with Photoshop

๐Ÿ• Category icons

Icons created with Krita

โœ๏ธ Flowchart

Flowchart created with Creately


๐Ÿ’ซ My experience

I found that creating the visual representations of the database, web flow and RESTful routes helped keep my project organised. Having a very clear structure and end goal in mind meant I was never stuck on what to do next.

Key learning:

  • Plan everything

Challenges:

  • CSS stylings
  • Displaying specific pages with specific paths

๐ŸŒŸ Show your support

Give this a star to show your support.

๐Ÿ“ฌ Contact me on

souperb's People

Contributors

typesammy avatar

Stargazers

Leslie Cayas 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.