GithubHelp home page GithubHelp logo

recipe-together's Introduction

Recipe Together

An app that allows random people to create recipes together, not knowing what ingredients the others add.

FVqxArKAcA

How it works

How the data is stored:

Recipes or rooms are stored using RedisJSON and RedisOM.

How the data is accessed:

Data is accessed using an index built at startup.

Prerequisites

  • Node.js 16.17.0 LTS

How to run it locally?

  • Clone the repository
  • Open two terminals, one in the backend folder, and one in the frontend folder
  • Run npm install in both terminals
  • Make a .env file in the backend folder with the following contents (Make sure to replace the value with your own):
    REDIS_URL=[YOUR REDIS CONNECT STRING]
    
  • Import example/ingredients.json into your Redis database at ingredients path
  • To start the frontend, run npm start in the frontend terminal
  • For the backend, run npm run watch in the backend terminal

Building

Frontend

  • Run npm run build in the frontend terminal

Backend

  • Run npm run build in the backend terminal

The build files can be accessed in the build folder for both the frontend and backend.

recipe-together's People

Contributors

jamdon2 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.