Skip to content

A web app that leverages artificial intelligence by evaluating your community based on your responses to question.

Notifications You must be signed in to change notification settings

nuthanan06/Community-Creator

Repository files navigation

Community Creator

Developed an interactive platform that provides users with AI-powered feedback to improve their community's sustainable practices. Users answer multiple choice questions and receive actionable suggestions to help create a more sustainable environment. Recieved YRHacks 2022 Sustainable Communities award for the project.

Front-end: React (Vite), Tailwind CSS
Back-end: Flask (using Cohere API)
Data Storage: JSON

Table of Contents

Installation

  1. Clone the repository

    git clone https://github.com/username/project-name.git
    cd Community-Creator
    
  2. Install Dependencies Create React project using Vite

    npm create vite@latest
    npm install
    
  3. Install Tailwind CSS and AOS

    npm install -D tailwindcss postcss autoprefixer
    npx tailwindcss init
    npm install --save aos@next
    
  4. Activate and Replace Cohere API Key

  5. Install Flask and Cohere

    pip install flask cohere
    
  6. Activate Python Virtual Environment

    cd flask-server
    python -m venv venv
    source venv/bin/activate  # macOS/Linux
    venv\Scripts\activate     # Windows  
    

Usage

  1. On three seperate terminals in the main directory, run the following commands.
    npm run dev
    npm run server
    python3 server.py
    
  2. Launch http://localhost:3000/.

License

This project is licensed under the MIT License.

About

A web app that leverages artificial intelligence by evaluating your community based on your responses to question.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published