Skip to content

Suban05/enjoyWord

Repository files navigation

EnjoyWord: Your Personal Dictionary

Build Status

image

EnjoyWord is a simple application for creating and managing your own dictionaries. It allows you to add new words and usage examples, as well as listen to the pronunciation of words.

Features

  • Create and manage your own dictionaries.
  • Add new words and usage examples.
  • Listen to audio pronunciation for added words.
  • Support for multiple languages.

Supported Languages

  • English
  • Spanish
  • German
  • French
  • Italian
  • Russian
  • Chinese

Highlights

  • Audio pronunciation is available only for words. Pronunciation of phrases, examples, and other content is not supported.

Setup Guide

Deploy in One Click

Render

Deploy to Render

  1. Click the button above
  2. Sign in or create your account with Render (FREE)
  3. Give your blueprint a name
  4. Select the master branch
  5. On your computer, open a terminal and make sure you have the openssl utility installed on your computer
  6. Generate your SECRET_KEY_BASE by running the following command in your terminal: openssl rand -hex 64 (docs)
  7. Go back to your browser and paste this value in the "Value" field for SECRET_KEY_BASE
  8. Click "Apply". This will take a few minutes
  9. Сlick on the enjoyWord "Web Service". You should see a custom URL in the format https://enjoyword-abcd.onrender.com. Click on it, and you'll run the enjoyWord app.

Using Docker

You can run the app using Docker Compose.

Step 1: Install Docker

  1. Install Docker Engine by following the official guide.
  2. Start the Docker service on your machine.
  3. Verify that Docker is installed correctly and running by opening a terminal and running:
docker run hello-world

Step 2: Clone the repository

  1. Create or navigate to a directory for your applications. For example:
cd ~/docker-apps
  1. Clone the repository:
git clone https://github.com/Suban05/enjoyWord.git

Alternatively, you can download the project files and add them to a folder.

  1. Navigate into the project folder. For example:
cd ~/docker-apps/enjoyWord

Step 3: Create your environment file

To configure the app, create a file named .env where Docker will read environment variables from. For example:

touch .env

Step 4: Generate the app secret key

The app requires an environment variable called SECRET_KEY_BASE to run. Generate it in your terminal (assuming openssl is installed):

openssl rand -hex 64

Save the generated key for the next step.

Step 5: Populate your environment file

Open the .env file and add the following variables:

SECRET_KEY_BASE=your_generated_secret_key
DATABASE_URL=postgres://postgres:postgres@db:5432/postgres

Step 6: Build and run the app

Execute these commands:

docker-compose build
docker-compose up

Your app is now set up and accessible at http://localhost:5000 in your web browser.

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •