Skip to content

Commit

Permalink
edit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Brandon Kudo and Chris Turina committed Dec 21, 2017
1 parent 281d940 commit 3c12244
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 25 deletions.
43 changes: 18 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,49 +11,42 @@
_Web app for TV display(1920x1080) to show Jeffrey's Flower and Oil dispensary menu. This app uses Greenbits API v1 to display Jeffrey's product offering. The app consists of 4 main components. The start screen, the flower screen, the concentrate screen, and the preroll screen. Each menu item provides detailed product information like: strain name, flower type, thc/cbd test results, price, and more! For more information on Jeffrey's flower and oil, [click here](http://jeffreysjoint.com/). For more information on Greenbits, check them out [here](https://www.greenbits.com/)._



## Specs

| Behavior | Input | Output |
|---|---|---|
| | | |
| | | |
| | | |


## Screenshots

![Welcome Page](img/homepage.png)
![Prerolls Page](img/prerolls.png)
![Flower Page](img/flower.png)
![Concentrates Page](img/concentrate.png)

## Further Exploration

Name check character length method for long names that mess with tables in menu


## Setup/Installation Requirements

1. _Open the Termial of the Computer and type:
git clone https://github.com/emilyjimenez/Jeffreys-GreenbitsAPI-Project.git
```_
1. _Clone [this repository](https://github.com/emilyjimenez/Jeffreys-GreenbitsAPI-Project.git) from Github in the terminal of your choice._

2. _Then type:
cd Jeffreys-GreenbitsAPI-Project_
2. _Install [node.js](https://nodejs.org/en/) if you do not have it installed._

3. _To run the application and view in your preferred browser of choice, run the following commands once you're in the project directory in the terminal. 'npm install', 'bower install', 'gulp build', and 'gulp serve'. **note** Project will not build if you do not have a .env file set up with an API token. API tokens are available for those who use the greenbits POS software._
3. _To run the application and view in your preferred browser of choice, run the following commands once you're in the project directory in the terminal. 'npm install', 'bower install', 'gulp build', and 'gulp serve'. **note** Project will not build if you do not have a .env file set up with an API token. API tokens are available for those who use the Greenbits POS software._

## Known Bugs

_If you press flower menu, then reload, and press concentrate menu the menu will load concentrates (wax shatter live resin) in the first column and then catridges in the second column… should be vice versa. Work around is to hard reload the page if this happens._
_If you press flower menu, then reload, and press concentrate menu the menu will load concentrates (wax shatter live resin) in the first column and then cartridges in the second column… should be vice versa. Work around is to hard reload the page if this happens._

## Technologies Used

* Atom
* HTML
* Sass
* Node.js
* Gulp
* Bower
* Babel
* CSS
* Sass
* JavaScript
* JQuery
* JQuery
* Node.js
* Gulp
* Bower
* Babel
* Google Chrome
* [Green API v 1](https://developer.greenbits.com/v1/)
* [Postman](https://www.getpostman.com/)
Expand All @@ -64,6 +57,6 @@ _License TBD

Copyright (c) 2017 Emily Wells Jimenez (EWJ Consulting), Brandon Kudo, and Chris Turina_

## Support and contact details
## Contact Details

_Interested in this product? Email emily@jeffreysjoint.com for more information._
_Interested in this product? Email emily@jeffreysjoint.com, brandonkudo@gmail.com, or chris.turina@gmail.com for more information._
Binary file added img/concentrate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/flower.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/homepage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/prerolls.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3c12244

Please sign in to comment.