Skip to content

nheek/motto

Repository files navigation

Motto

Motto front page

Motto is inspired by the film Ron's Gone Wrong. It is a virtual friend that should be able to talk to you naturally and be there when you need it! The name "Motto" was coined by my brother who heard me brainstorming about the name that I should use. AI logic originally built from scratch is now made easy with OpenAI!

Table of Contents

Getting Started

Just follow the steps below and you should be good to go.

Prerequisites

  • Node.js
  • npm (usually comes with Node.js installation)

Installation

  1. Clone the repository:

    git clone https://github.com/nheek/motto.git your-project
  2. Change into the project directory:

    cd your-project
  3. Install dependencies:

    npm install

Development

Run the development server:

npm run dev

Usage

Motto is an AI that acts as your virtual friend. You can ask it about things you would normally tell a friend. It has a very cozy welcome page that allows you to pet a dog before entering the chat section itself.

Deployment

  1. Build the project files
npm run build
  1. Run using the NextJS command or use your production deployment method
npm start

Built With

Contributing

If you'd like to contribute, please fork the repository and create a pull request. Issues and feature requests are welcome!

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Acknowledgments

Special thanks to everyone who had indirect contributions to this project through the inclusion of their works which are specially mentioned in the source code.