This is the monorepo for Chicken Tinder.
Product Vision: For friend groups who can’t decide where to eat in a timely manner, Chicken Tinder is a web app that collects food preferences within groups and picks a restaurant catered to the group’s preferences. Unlike Yelp, our product enables collaboration within customizable groups of users.
The deployed app can be viewed at: https://thechickens.netlify.app
And the backend can be accessed from: https://chickentinder-backend.azurewebsites.net/
Here is a video demo of our product (last updated 3/13/24)
UI prototypes and designs are located in Figma (last updated 2/27/24):
Class diagram (last updated 3/12/24):
This script clones the repo (with SSH) and creates the necessary .env
files. The backend env file must be configured with the relevant secrets. The JWT secret key can be any string.
git clone [email protected]:the-chickens-x5/chicken-tinder.git
cd chicken-tinder
npm install
echo 'DB_PASSWORD=copy_password_here \nTENOR_API_KEY=copy_key_here \nJWT_SECRET_KEY=copy_key_here' > ./packages/backend/.env
echo 'REACT_APP_API_URL=http://localhost:8000' > ./packages/frontend/.env
To start up local instances:
npm run backend-dev
npm run frontend-dev
Before commiting/pushing, maintain style conventions with:
npm run format
npm run lint
To run Cypress testing once:
npm run test
To open the Cypress GUI (make sure the frontend and backend are both up):
npm -w testing run cy:open
In general, if you want to add your own env variable, use REACT_APP_{varname}={varval}
. Then you can read it with process.env.REACT_APP_{varname}
.