hueper/espresso

Learning while drinking a caffé

Espresso Language Learning App

Welcome to Espresso, the language learning app that lets you enhance your language skills while enjoying a cup of coffee!

Table of Contents

• Introduction
• Features
• Getting Started
• Usage
• Customization
• Contributing
• License

Introduction

Espresso is a web application designed to make language learning a delightful experience. The claim, "learning while drinking a caffé", reflects the idea that language learning should be enjoyable and seamlessly integrated into your daily routine.

Features

• Swipe Interface: Easily indicate your understanding of expressions by swiping left or right.
• React Framework: Built with React for a responsive and interactive user experience.
• Expression Repository: Expressions to learn are stored in a JSON file at src/data/expressions.json.

Getting Started

To get started with Espresso, follow these steps:

1. Clone the repository to your local machine:

   git clone https://github.com/hueper/espresso.git

2. Navigate to the project directory:

   cd espresso

3. Install dependencies using Yarn:

   yarn install

4. Start the development server:

   yarn start

5. Open your browser and visit http://localhost:3000 to view Espresso.

Usage

Once you have Espresso up and running, you can start using it to enhance your language skills. Swipe left if you didn't understand the expression, and swipe right if you did.

Customaization

Feel free to customize Espresso to better fit your needs. You can modify the expressions in the expressions.json file to tailor the learning content to your preferences.

Contributing

If you'd like to contribute to Espresso, follow these steps:

1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.
3. Create a new branch for your feature or bug fix.
4. Make your changes and commit them with descriptive commit messages.
5. Push your changes to your GitHub repository.
6. Submit a pull request to the main repository.

License

Espresso is released under the MIT License.

espresso's Issues

add db to store expressions

mongodb?

modify component and add flask route to get expressions from a server

instead of parsing a json file, a get request should be sent to a server to receive the expressions.

useEffect(() => {
    const fetchExpressions = async () => {
      try {
        const response = await axios.get('/api/expressions');
        setExpressions(response.data.phrases);
      } catch (error) {
        console.error('Error fetching expressions:', error);
      }
    };

    fetchExpressions();
  }, []);

EXPRESSIONS_FILE = 'expressions.json'

def read_expressions_from_file():
    with open(EXPRESSIONS_FILE, 'r', encoding='utf-8') as file:
        expressions_data = json.load(file)
    return expressions_data

@app.route('/api/expressions', methods=['GET'])
def get_expressions():
    expressions_data = read_expressions_from_file()
    return jsonify({'phrases': expressions_data['phrases']})