What's for dinner? Tinnr, it's for dinner.
Tinnr is a project dedicated to offering users with many different recipe choices. Our goal is for people to explore new recipes that fit any occasion.
We have used bower and npm to install our dependencies. We also used Mongod and nodemon to run a local database and server. The bower dependencies will be downloaded to a lib folder, which is pre-specified in the .bowerrc file. Before running locally, run the following code in the command line.
bower install
npm install
mongod
nodemon server/server.js
Note: To use mongod, you must set the database path. You can do so with the following command.
mongod --dbpath <path>
Currently, we have a test for our server side inside our test folder.
We separated our files into 3 different folders: Client, Server, and Tests. Within each of these folders, we split our code up into as many files as we could in order to modularize it.
For this project, we have used AngularJS, Twitter Bootstrap, font awesome, Sass, Lo-dash for our front end and Node.js, Express, and MongoDB for our server and database. We also used Gulp for automation of our workflow. For testing we used mocha.
We used MongoDB for the document storage of the Users and the Recipes. We used an ORM called mongoose, which is an npm module, which gives us easier access to our database. Refer to this link to learn more about mongoose Mongoose Docs. We used MongoLab as a heroku addon when deploying our app.
We used Yummly's API for our recipes. Yummly API Documentation
- Users
- Recipes
- Each user can save recipes
- Clicking on the saved recipe will forward you to the recipe
- Can filter by Diet, Cuisine, and Course
- Preferences are saved to the User
- Swiping for recipes
- Compile all saved recipe ingredients to make shopping list
- Show number of user favorites on saved recipes (We already iterate the numberOfSaves in the recipe Schema)
- Refactor to a SQL database for larger production scale
- Implement search box for query string in api call
- Allow user to submit included and excluded recipes
- Display a user dashboard
Please refer to the CONTRIBUTING.md file to see our git workflow.
We used airbnb's es5 style guide at the following link airbnb es5 style guide
- Elliot Chi (elliotschi)
- Peter Kaiser (pkaiserui)
- Ian B. (ibari)
- Sean Gibson (seanagibson)
MKS Greenfield Project