README.md

🍦 iScream 🍨

Designed and Developed by:

• Maria: Scrum Facilitator
• Alex: Devops
• Sonia: Quality Assurance
• Peter: UX Lead

Summary

A site for posting about ice cream, made with Postgres so that your opinions are stored indefinitely.

User Stories

• I have strong opinions on ice cream and want to share them
• I want to read others' views on ice cream
• I like structure and want a tailored form in which to submit my opinions
• I use a screen reader and want to post and read posts

User Journey

• User arrives on home page
• User fills out a form outlining their views on ice cream
• User arrives on a page where they can see the views of others as well as their own

👨‍💻To run the application as a developer:

• Get the files git clone https://github.com/fac24/week1-asmahan-george-bereket-maria.git
• Make sure you go inside the repo folder cd <the-repo-folder>
• Install dependencies to get your server running! npm install
• To create local database run ./scripts/create_db
• Then run ./scripts/populate_db to poulate the database
• Run psql (if on Windows run sudo service postgresql start first!)
• The \connect <name of your local database>
• \dt if you want to see your databases ;)
• Start the server npm run dev
• Go on to http://localhost:3000 to visit the app

To run tests:

• Install cyress npm install -D cypress
• Ensure your in the project folder and npm run test
• Cypress should pop up!
• Edit the test.js file to make your own tests
• Have the server running in one terminal and cypress in another for optimal productivity!

Schemata

We used two tables for this project: firstly, a table users to store information about users of the site; secondly, a table ice_cream_posts to store information on those users opinions and comments on ice cream.

schema for users table

schema for ice_cream_posts table