Skip to content

Latest commit

 

History

History
103 lines (72 loc) · 2.27 KB

README.md

File metadata and controls

103 lines (72 loc) · 2.27 KB

overlay-theater image gallery

reusable react components for web dev

giving your components useful css via styled-components

by Ben Mangold

Tools to build

Includes a full stack demo component /react-client/src/productGallery/ProductGallery.jsx

A web service and db are provided with scripts to seed the demo db and serve the demo component

React, Node.js, MongoDB

demo video

gist with sample request

Continuing Development

Occurs on dev branch, which will periodically PR into master

Branch off of dev, naming the branch after a ticket on trello

trello task board

Component Usage

Scrollover Provider - display a centered image when moused over

<ScrollOverProvider>
  <img src='https://i.imgur.com/ZfnIxu8.png' />
</ScrollOverProvider>

Overlay Provider - give each child a fullscreen overlay which displays the item when clicked

<OverlayProvider>
  <div>Hi 1</div>
  <div>Hi 2</div>
  <div>Hi 3</div>
  <img src='https://i.imgur.com/K9PPMZK.jpg' />
</OverlayProvider>

Overlay Renderer - render a fullscreen overlay with a carousel functionality to view a list of items

<OverlayRenderer
  // overlay trigger
  render={() => <div>Click me</div>}
  // overlay content
  renderBanner={() => <div>Big image</div>}
  renderCarousel={() => [
    <div>Carousel item 1</div>,
    <div>Carousel item 2</div>,
  ]}
/>

TODO Carousel Provider - give each child a fullscreen carousel overlay with all other children

<CarouselProvider>
  <div>Hi A</div>
  <div>Hi B</div>
  <div>Hi C</div>
</CarouselProvider>

Running Web Service Locally

$ npm install
$ npm run server-dev
$ npm run react-dev

Seed Local MongoDB

Make sure MongoDB is installed and running at mongodb://127.0.0.1:27017 The app is configured to use:

database: deltaDrop collection: products

$ npm run seed

Web Service Deployment

Required: DB_PROVIDER env variable must be available in production enviornment, pointing to prodcution db

ex on ec2: ec2-instance$ export DB_PROVIDER=mongodb://<un>:<pw>@ds249583.mlab.com:49583/delta-drop