written-pronunciation

Although you can view this project on the site (the project was primarily built for the desktop, so its mobile UI is far from being aesthetic and responsive -help wanted!-), it is no longer active or maintained. Still, you can open an issue or a PR if you find a critical bug, I'll fix it ASAP.

An English written pronunciation site for Turkish hard of hearing and deaf people who can't listen to words' verbal pronunciation. It was my second project and I developed it while learning Django, Django Rest Framework and back end development in general.

Features

Bootstrap4.
User authentication & authorization.
Create, Read, Update and Delete functionality.
Pagination.
Searching.
API authentication & authorization.
API CRUD functionality.
API documentation.
Thorough and elegant tests.

Live showcase

API Registration & Authentication

API

API Documentation

Main Documentation

Installation

Clone the project

Depending on the choice of yours, you can clone the project in various ways. Either via IDE, Git Desktop or Git commands.

Whatever the case, make sure Git is installed and after cloning the project, you are at the same working directory with the project.

Look below for cloning the project via bash:

$ git clone https://github.com/Ksenofanex/written-pronunciation.git

$ cd written-pronunciation

$ pwd
/written-pronunciation

Environment Variables

Before installing the project, you need a proper .env file. The project's settings.py module is depending on these variables.

The project has a fictional env file for educational purposes. You can either manually create a .env file or enter the command below to the bash/terminal to clone a proper .env file:

$ cp .env.example .env

An example configuration for the .env file:

DEBUG=True
SECRET_KEY=itdb4-_wc!=*hgl3)h@v$#jy7bxingn(n+qklsdso%9yq&c5)!

You can generate the SECRET_KEY via sites like Djecrety and add it to the .env file.

Set DEBUG to True while developing and testing in local/testing environments. Otherwise, set DEBUG to False.

After properly configuring the environment variables, you can proceed to the Venv section to initialize the project.

Venv

Make sure your working directory is the same with the project and virtualenv package is installed in your OS.

Windows

> pwd
\written-pronunciation

> pip install virtualenv

> virtualenv env

> .\env\Scripts\activate

> pip install -r requirements.txt

> python manage.py makemigrations

> python manage.py migrate

> python manage.py runserver

Linux

$ pwd
/written-pronunciation

$ pip3 install virtualenv

$ python3 -m venv env

$ source env/bin/activate

$ pip3 install requirements.txt

$ python3 manage.py makemigrations

$ python3 manage.py migrate

$ python3 manage.py runserver

After the installation process, you must see this output:

Then you can start exploring the project from either http://localhost:8000/ or http://localhost:8000/api. Happy coding!

Remember, you must approve the created Words from the admin panel in order them to be visible across the project.

You can access to the documentation of the project from this URLs (http://localhost:8000/swagger-docs/ or http://127.0.0.1:8000/swagger-docs/).

Ksenofanex/written-pronunciation