UnStarve is a web application developed for the Hackhound MLH hackathon that provides an AI-based food recommendation system. The application uses Node, Express, CockroachDB, Twilio, Cohere, Github, and Figma to provide a seamless food ordering experience for users.
Unstarve comes with the following features:
- Users can sign up, log in, and log out of the application.
- Users can search for food based on their location, cuisine, and dietary preferences.
- Users can receive personalized food recommendations based on their previous orders, ratings, and preferences.
- Users can view the restaurant menu and add items to their cart.
- Users can customize their orders by adding or removing ingredients, specifying cooking instructions, and requesting special requests.
- Users can place orders, view their order history, and track the status of their orders in real-time.
- Users can receive real-time notifications via SMS using Twilio.
Unstarve is built using the following technologies:
- Node.js: A JavaScript runtime that executes JavaScript code outside of a web browser.
- Express: A fast, minimal, and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.
- CockroachDB: A distributed SQL database that provides global scale, multi-active availability, and transactional consistency across multiple data centers.
- Twilio: A cloud communications platform that enables developers to build SMS, voice, and messaging applications.
- Cohere: An AI platform that helps developers build natural language processing (NLP) applications.
- Github: A web-based platform for version control and collaboration.
- Figma: A web-based vector graphics editor and prototyping tool.
To run the Unstarve application on your local machine, follow the steps below:
- Clone the repository:
git clone https://github.com/ravanpreet-kaur/unstarve.git - Navigate to the project directory:
cd unstarve - Install the dependencies:
npm install - Set up the environment variables by creating a
.envfile based on the.env.examplefile. - Start the application:
npm start
If you would like to contribute to Unstarve, please follow these steps:
- Fork the repository: https://github.com/ravanpreet-kaur/unstarve.git
- Clone the forked repository:
git clone https://github.com/your-username/unstarve.git - Create a new branch for your feature:
git checkout -b feature/your-feature - Make the necessary changes and commit them:
git commit -am 'Add some feature' - Push the changes to your branch:
git push origin feature/your-feature - Submit a pull request to the original repository.
Unstarve is licensed under the MIT License. See LICENSE for more information.