https://github.com/jeanmathieupotvin/foodsviewer

A private and secure front-end interface to the digest package.
https://github.com/jeanmathieupotvin/foodsviewer

digest eat expres-js foods gut viome

Last synced: about 2 months ago
JSON representation

A private and secure front-end interface to the digest package.

• Host: GitHub
• URL: https://github.com/jeanmathieupotvin/foodsviewer
• Owner: jeanmathieupotvin
• License: mit
• Created: 2021-05-01T22:39:54.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-17T18:04:20.000Z (almost 2 years ago)
• Last Synced: 2023-03-07T15:27:07.648Z (almost 2 years ago)
• Topics: digest, eat, expres-js, foods, gut, viome
• Language: JavaScript
• Homepage: https://foods.potvin.xyz
• Size: 261 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        



# FoodsViewer

A private and secure front-end interface to the

[digest](https://github.com/jeanmathieupotvin/digest) package.

First and foremost, built for me and my girlfriend.

# Overview



  

  



# Description

FoodsViewer is a responsive web application to better visualize results stemming from Viome 

Gut Intelligence Test® kits. It uses the data structures of

[digest](https://github.com/jeanmathieupotvin/digest) to better combine results of a couple,

here **mine**. It is a **private** application. You cannot sign up, and you cannot use it. This

is because I am not affiliated to Viome® in any way. For more information on this, see section

[Disclaimer](#Disclaimer) below.

# Why is this code public?

Because you can easily clone this project, deploy it, and use it privately, just like I do. I

made my best to make it production ready. Note that you will have to go through the following

steps before deploying.

1. Create a private, untracked, `crypt/` folder. This folder will contain your users' information

and data (basically JSON files containing unparsed `digest::FoodCollection`).

2. Create a private, untracked, `.env` file with some secret `SESSION_TOKEN` environment

variable. Make it random, really long, and **hide it** at all costs. You will also have to

set a second environment variable `NODE_ENV` equal to `development` or `production`.

3. Compile the production versions of the CSS and JS scripts with the `npm` commands defined in

`package.json`.

4. Create a `private/images/foods` folder, and populate it with images of all the foods included in

your `digest::FoodCollection`(s). Make sure that names passed to all `Food::imgFile` match the names

of your foods' images.

5. Finally, publish to the web, in one click. (Anyone else tired of these annoying YouTube's

*Webflow* ads?)

> Anyone else tired of these annoying YouTube's *Webflow* ads? - *Litterally every developer on the planet*.

# Implementation

This web application is an Express application embedded into a single [Node](https://nodejs.org/en/)

process. It uses

* [EJS](https://ejs.co/) as its templating system;

* [memorystore](https://www.npmjs.com/package/memorystore) to store sessions' IDs and cookies on the server;

* [bcrypt](https://www.npmjs.com/package/bcrypt) to manipulate sensible information such as passwords;

* [Passport](https://http://www.passportjs.org/) for the authentication strategy;

* [SASS](https://sass-lang.com/) to build CSS files;

* [PostCSS](https://postcss.org/) to minify CSS files and

* [UglifyJS](https://www.npmjs.com/package/uglify-js) to compress and minify client-side JS scripts.

The code is straightforward, follows usual Express conventions, and is well documented. It won't

be complicated to adapt, I guarantee it. 😄🌈

# Disclaimer

I am not affiliated to Viome® in any way. FoodsViewer is an independent project.

No Viome® data is exposed by FoodsViewer. It assumes that each user builds its own application and its

own datasets manually, from their personal results.

Viome® and Viome Gut Intelligence Test® are registered trademarks. Buy your own kit online from their

[online store](https://beta.viome.com/products/gut-intelligence).

# Bugs and feedback

Submit them [here](https://github.com/jeanmathieupotvin/foodsviewer/issues). Also, if you have the

time to give me some feedback, I would really appreciate it. It is always reassuring to have

someone else look at your code. Thank you!