tylrs / turing-two-cents

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Table of Contents

Overview and Project Goals

Welcome to the Turing Tip Jar - where students and alum can choose to simply peruse tips, or can leave tips to help others wade the trecherous Turing waters!

The goal of this Mod3 group project was to stretch boundaries and branch out on our own to teach ourselves new tech. We chose to dive into the backend technologies. We built our own server using express and built a database using PostgreSQL. We deployed our database to Heroku and built our frontend using React.

Installation and Viewing

Our application is deployed to Heroku. You may view the live application here

Our Express server is located in another repo here

To view our application on your local device:

  • Clone down this repository
  • Run npm i in your terminal
  • Run npm start in your terminal
  • To view Cypress tests open a separate tab in your terminal and run npm run cypress
  • You do not need to clone our API as it is already deployed to Heroku

Learning Goals

To solidify and demonstrate the understanding of:

  • The ability to independently learn a new technology
  • Building a server through Express
  • Establishing and seeding a database using PostgreSQL
  • Deploying a database
  • Building a frontend using React to display data

Technologies Used

React Badge JavaScript Badge HTML5 Badge CSS3 Badge Sass Badge Express Badge Cypress Badge

Functionality

View All Tips

  • A user may view all tip cards previously added
    Demo browsing tips on main page

Add a tip

  • The user may fill out the input fields and click submit to add a tip
    Demo adding tip to main page

Search tips added by module number

  • The user may click on a module button in the header to search tips by module number
    Demo searching for tips by module

Mobile View/Responsive

  • Site is responsive and will change layouts across desktop, tablet, and phone screens
  • Demo responsive design for site

Future Additions

  • *Add login functionality so that users can view their personalized dashboard (edit or delete their own tips)
  • *Add upvotes so that users can upvote and down vote tips once they are logged in
  • Share: ability to share tips via social media or email

Want to Contribute?

If you would like to contribute, please fork this repository and clone it down to your local machine. Once you've successfully implemented the changes in code necessary for your intended contribution without changing any of the current functionality of main, submit a pull request for authors to review the changes.

Contributors

Authors


Back to top

About


Languages

Language:JavaScript 82.4%Language:CSS 15.3%Language:HTML 2.3%