JamDon2 / recipe-together

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.

About

License:MIT License


Languages

Language:TypeScript 93.8%Language:HTML 3.4%Language:CSS 2.8%