TrojanEat
TrojanEat copied to clipboard
AdamYang1
A mobile app helping USC students
TrojanEat
An awesome application for USC student!
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
About the Project
This is a USC dining hall recommendation application specifically targeting Chinese Freshman who are likely to have hard time reading menus. It saves students time by providing translations, recommendations, and dining hall details (ex. vegan dining hall). Users will be asked to pick their favourite types of food and will receive recommendation dining hall accordingly.
Important Note
This is an application deployed on WeChat-based environment. Therefore, you have to install WeChat on your phone to use this application. Nevertheless, you are welcome to test the server using APIs.
Even though it is designed for USC Chinese student, everyone is welcome to use the app and contribute to the app.
Prerequisites
This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.
$ npm -v && node -v
6.4.1
v8.16.0
Table of contents
- About the Project
- Important Note
- Prerequisites
- Table of contents
- Getting Started
- Installation
- Testing
- Testing the app
- API
- Routes
- Contributing
- Built With
- Author & Contributors
- Acknowledgements
- License
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Installation
BEFORE YOU INSTALL: please read the prerequisites
Start with cloning this repo on your local machine:
$ git clone https://github.com/AdamYang1/TrojanEat.git
$ cd TrojanEat/cloud
To install and set up the library, run:
$ npm install
Testing
Testing the app
$ npm start
API
Routes
| Route | Utility |
|---|---|
| db | connect to database (hided) |
| menu | get all menu & recommended menu |
| personal | get & update user preferences && update dining hall ranking based on user choices |
| procdata | get & update user preferences && update dining hall ranking based on user choices |
| recommend | analyze & update user preferences && return recommendation |
| allergen | update & get user allergen (deleted) |
| vegan | analyze & return the vegan dining hall on Monday |
If present, the request will be performed as soon as the component is mounted
Contributing
Please read follow process for submitting pull requests to us.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Add your changes:
git add . - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :sunglasses:
Built With
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
(back to top)
Author & Contributors
See also the list of contributors who participated in this project.
Acknowledgements
This project was developed by, is maintained by, and is sponsored by Shixiang (Adam) Yang all independently. It incorporates extensive feedback from many USC students to mention here, including many contributors who have helped to design UI, LOGO, and contribute great ideas, and so on.
This project is largely based on the menu released by USC Dining and the translation for is primarily based on pygtrans. There might be some bugs and inappropriate translations leading unpleasant experience, please kindly inform me if it happens and everyone is welcome to contribute.
License
MIT License © Shixiang Yang
AdamYang1