Giter VIP home page Giter VIP logo

pet-name-generator-service's Introduction

πŸ’» Mountain Madness Hackathon 2023 πŸ’»

Rubey on Tails πŸ•

VIDEO DEMO: https://youtu.be/psBENhE4XDA

This web app generates funny pet names for all kinds of animals, making POST requests to the OpenAI API that generates a pet name using Natural Language Processing. It makes additional GET requests to another API (node-server), which makes GET requests to another API (french-translator-server) which takes in the AI generated pet name and translates it to a newly invented language, known as French++.

image

Rubey - a complicated solution to a simple problem.

image

Setup user app

  1. If you don’t have Python installed, install it from here

  2. Clone the user app repository, and navigate to the project directory

    $ git clone https://github.com/dannyl1u/pet-name-generator-service.git
    $ cd pet-name-generator-service
  3. Install the requirements

    $ pip install -r requirements.txt
  4. Make a copy of the example environment variables file

    $ cp .env.example .env
  5. Add your API key to the newly created .env file

  6. Create a new virtual environment

    $ python -m venv venv
    $ . venv/bin/activate
  7. Run the app

    $ flask run

You should now be able to access the app at http://localhost:5000

Now we need to setup our backend servers for the app to work:

Node Server https://github.com/dannyl1u/node-server

  1. Clone the repository

    $ git clone https://github.com/dannyl1u/node-api.git
  2. Navigate into the project directory

    $ cd node-api
  3. run npm install

    $ npm install
  4. Run the server

    $ node .

Server should now be up at http://localhost:8080

French translater Server

https://github.com/dannyl1u/french-translator-server

  1. Clone the repository and navigate to the directory

    $ git clone https://github.com/dannyl1u/french-translator-server.git
    $ cd french-translator-server
  2. Ensure python is installed.

    $ python --version
  3. Install flask

    $ pip install Flask
    # we might need to replace pip with pip3
    # this also requires that pip is installed
    $ pip --version
  4. Run the server

    $ python api.py

Server should now be up at http://localhost:8000

All done. Head back to the user app at http://localhost:5000 and generate your pet name!

pet-name-generator-service's People

Contributors

dannyl1u avatar logankilpatrick avatar jeevnayak avatar athyuttamre avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.