No More Ramen

The website that helps students learn and share recipes that are easy to make with a student budget.


Project maintained by no-more-ramen Hosted on GitHub Pages — Theme by mattgraham

ci-badge

Overview

The Problem

Many college students have limited cooking skills, limited time, limited access to grocery stores, and no access to creative recipes that are within these contraints. As a result, students end up spending lots of money at fast food places or through vending machines.

The Solution

No More Ramen is a web application that will allow students to learn and share recipes that:

The goal of this site is to help improve the nutritional content and variety of foods consumed by students.

Developer Guide

Installation

First, install Meteor

Second, visit the No More Ramen application github page, and click the “Use this template” button to create your own repository.

Third, go to your newly created repository and download your new GitHub repo to your local file system. GitHub Desktop is a great choice if you use MacOS or Windows.

Fourth, cd into the app/ directory of your local copy of the repo, and install third party libraries with:

$ meteor npm install

Fifth, run the system with:

$ meteor npm run start

If all goes well it will appear at http://localhost:3000/

ESLint

To verify that the code obeys coding standards, you can run ESLint over the code using:

meteor npm run lint

Development History

Milestones Description
M1 Our main goal of Milestone 1 was to create Mockups of our pages so we had a general idea of how we wanted our site to look like. We also created a landing page. The landing page is meant to help users get a general understanding of what our website is about.
M2 Our main goal of Milestone 2 was to improve the functionality and quality of our website beyond Milestone 1.
M3 Our main goal of Milestone 3 was to implement a significant amount of real information. We also asked for user feedback.

Deployment

Our project is deployed on Digital Ocean for everyone to see it.

User Guide

The following sections describe the major features of this template.

Landing page

When you first visit the site, this is what should be displayed:

The next step is to use the Login menu to either Login to an existing account or register a new account.

Login page

Clicking on the Login link, then on the Sign In menu item displays this page:

Register page

Alternatively, clicking on the Login link, then on the Sign Up menu item displays this page:

Sign Out page

After logging out, this page displays:

Student Home page

Once you log in (either to an existing account or by creating a new one), the navbar changes as follows:

You can now add new Recipe documents, and list the recipe you have created. Note you cannot see any Recipe created by other users.

Vendor Home page

This page lists all ingredients that a vendor has listed for sale with the option to edit an existing ingredient and add new ingredients.

Admin Home page

You can define an “admin” user in the settings.json file. This user, after logging in, gets special entries in the navbar:

Admins are able to view and edit all existing users. Admins also have the ability to view all of the added ingredients and recipes, sorted by the added date. They are able to remove or edit specific items.

Student Profile page

After you log in, you can click on a dropdown on the navbar to get to your profile:

Vendor Profile page

After you log in, you can click on a dropdown on the navbar to get to your profile:

Add Recipe page

After logging in, here is the page that allows you to add new Recipe:

Add Ingredients page

This page will allow vendors to add ingredients:

Individual Recipe page

This page contains the full details of each recipe including a photo, dietary restrictions, ingredients list, and instructions. Users can see which vendors are selling the ingredients by hovering over each ingredient in the list. Users can favorite a recipe by clicking on the star icon.

Favorites page

This page shows all the recipes that a user favorites.

Search Recipe page

This page allows you to search for a recipe based on name, ingredients, size, etc.

Search Ingredients page

This page allows you to search for an ingredient based on name, quantity, price, and vendor.

Community Feedback

David L.

Simplicio J.

Jeraldine M.

Branden T.

Sky K.

Team

No More Ramen is designed, implemented, and maintained by a team consisting of five members: Bradley Valiente, Shannon Kam, Kayla Hirano, Khanh Nguyen, and Jun Kim.

All members have signed a team contract.