ykdojo/editdojo

(I'm no longer working on this - currently working on https://github.com/ykdojo/defaang)

Edit Dojo

A web app to improve writing skills in any language.

Screenshots

Inspiration

The inspiration for this came from the lack of these kind of resources. You can find a ton of resources to master reading, listening or speaking a language. But when it comes to writing, there simply aren't much.

How it works

The app will function in these steps:

1. A user A will sign up with 2 languages, one in which they are proficient(say, English) and the other which they want to learn(say, Japanese).
2. Then they will write anything they need in, say, Japanese.
3. A user B, who is proficient in Japanese, will then verify and propose corrections.
4. Similarly if someone wants to learn English, user A can verify their messages.
5. Everyone is happy.

Initially the app will be based on twitter, that is, users will be editing tweets. Eventually, you will able to use this app without using Twitter at all!

Waiting list

If you'd like to get an email when this website/app is ready, please sign up to our waitlist here: https://www.csdojo.io/wait

Pre-requisites

We would need following installed in our system before we start with setting up the project in local machine.

1. Git - This is needed as a version control system. If you don't have this preinstalled in local machine, visit https://git-scm.com/downloads and setup git on local.
2. Python 3 - We are using Python as a programming language in this project. Mac and Ubuntu have it pre-installed. NOTE: you might have Python 2 on your Mac or Ubuntu. If so, make sure to download Python 3.

Local Setup

1. Clone this repository into local system and change the directory.

git clone https://github.com/ykdojo/editdojo.git
cd editdojo/

2. Install pip3 and pipenv.

pip3 install pipenv

3. Go into the virtual environment:

pipenv install
pipenv shell

4. Apply migrations

python manage.py makemigrations
python manage.py migrate
python manage.py loaddata languages.yaml
# NOTE: you can produce the same data in languages.yaml with
# python manage.py dumpdata users.Language --format=yaml > languages.yaml

5. Set up Twitter

For this, first, set up your environment variables.

You can take a look at .bash_profile_sample on how to set them up.

Then, run:

python manage.py shell < setup_twitter.py

On Heroku:

heroku run manage.py shell

exec(open("./setup_twitter.py").read())

6. Run the server:

python manage.py runserver <PORT>
OR
python manage.py runserver

7. Start the application opening the link shown in your terminal on a browser.

Resources

This is a part of the series of YouTube videos demonstrating how to build a real startup using Python and Javascript. Useful resources for this project:

• YouTube video link: https://www.youtube.com/watch?v=UyQn0BhVqNU
• Slack group and more info: https://www.csdojo.io/edit
• Waiting list for this app: https://www.csdojo.io/wait
• Recommended Django book for beginners: http://csdojo.io/dj (It's a referral link. When you buy a copy from this link, YK gets paid a little bit - which will help him continue working on this project full-time.)
• Sample chapters of this book: https://djangoforbeginners.com/

Created by

The project was started by: YK Sugi. He's the guy who's running CS Dojo, a programming education YouTube channel.

If you have any questions related to this project, please contact him on our Slack group.

editdojo's Issues

Fix the behavior that occurs when the user cancels the Twitter login dialogue

Currently, the app just redirects to django-allauth's default view. We should fix it.

Should we use Node.js for this project?!

Okay, so I'm happy with using Django so far (even though I haven't built much yet).

However, it seems like Node.js is much more popular these days for backend development.

I'm kind of starting to think, should we use Node.js and maybe Express.js for this project? I know that Node.js is much simpler, but would it be a good tech to use for this particular project?

(I probably won't switch, but I just wanted to throw this idea here just to start up a discussion about it - since this is something I've been wondering about for a few weeks.)

How about accounts?

Maby we should start thinking about creating views and models for users accounts?

Update the Django version to 2.1.2, which is the latest one.

It's just because GitHub says Django < 2.1.2 has some security issues. I'm not sure what they are exactly, but probably better to be safe here.

Create a hello world app

This is going to be my next video.

Make a worker script

Decide which CSS framework to use

I'm thinking of using either Bootstrap (https://getbootstrap.com/) or Materialize (https://materializecss.com/).

Which one is better? Are there any other good options?

Create a better sign out form

Currently, it's just django-authall's default view. Fix it.

Take care of a case when a user's Twitter account is private

Make the welcome message look prettier

I made the text in #40, but it's freakin ugly right now lol

The Twitter sign in dialogue asks for too many things.

We don't need to read or post tweets on behalf of the user. Maybe we should fix this on Twitter's developer website? (Don't add read/write permissions there?)

Install material-kit (the free version)

https://github.com/creativetimofficial/material-kit

Figure out what license we should use for this project

This is my first open source project, so I don't know. MIT? Apache? Or something else?

Automatically detect if the given text is Japanese or English with Python

I think I'm going to release the Twitter-based version of this product for Japanese and English first. So, we should be able to detect if a given tweet is written in Japanese or English with Python. This way, we can only show Japanese tweets coming from Japanese learners to native speakers of the language. Same with English.

Fix the styles of sign up form where the new user selects languages

I think the functionality of this one is good now (#39). It's just a matter of fixing the UI to make it look prettier.

Create a sign up form where the new user selects which language they are learning

We're going to start with just Japanese and English.

When a user signs in, show their Twitter handle (plus maybe store it as a username?)

Fix the name convention - make it more consistent.

Find the difference between two sets of text with JavaScript

Example:

• Original text: I had aweesome breakfast tooday.
• Edited text: I had awesome breakfast today.

Given these two sets of text, we should be able to find the difference with JavaScript. And show the difference in UI. This way, it'll be easy to see how the original text has been edited.

In this case, it should look like this: I had awe<e>some breakfast to<o>day.

(Where <e> and <o> have strikethrough over them)

Change the database management system

Which database manager do you consider the best option to use in the project?

DoesNotExist at /accounts/twitter/login

Request Method:	GET
http://127.0.0.1:8000/accounts/twitter/login/
2.1.2
DoesNotExist
SocialApp matching query does not exist.
C:\Users\ninte.virtualenvs\editdojo-mEFwjXpH\lib\site-packages\django\db\models\query.py in get, line 399
C:\Users\ninte.virtualenvs\editdojo-mEFwjXpH\Scripts\python.exe
3.7.2
['E:\editdojo', 'C:\Users\ninte\.virtualenvs\editdojo-mEFwjXpH\Scripts\python37.zip', 'C:\Users\ninte\.virtualenvs\editdojo-mEFwjXpH\DLLs', 'C:\Users\ninte\.virtualenvs\editdojo-mEFwjXpH\lib', 'C:\Users\ninte\.virtualenvs\editdojo-mEFwjXpH\Scripts', 'C:\Users\ninte\AppData\Local\Programs\Python\Python37-32\Lib', 'C:\Users\ninte\AppData\Local\Programs\Python\Python37-32\DLLs', 'C:\Users\ninte\.virtualenvs\editdojo-mEFwjXpH', 'C:\Users\ninte\.virtualenvs\editdojo-mEFwjXpH\lib\site-packages', 'c:\users\ninte\.virtualenvs\editdojo-mefwjxph\src\tweepy']
Sat, 21 Sep 2019 19:42:30 +0000

Make a simple Twitter bot with Python

This is just so that we can learn how to use Twitter API.

Maybe something that says "hello, world back to you!" when it receives a Twitter mention that says "hello, world!"

Hello YK

is this project still alive

Create welcome text that explains how the app works

Fix the scrolling issue on the phone

When you slowly scroll on the sign up page on my iPhone, the whole screen expands and contracts vertically.

When following a user on Twitter, use their ID instead of their handle

We need to do this just in case the user changes their user handle on Twitter.

Create the *Sign Up with Twitter* function

[Installation] Keys_format.py instead of keys.py?

Decide how to deploy this app

Python Anywhere's cheapest option might be just enough for now ($5/month for 1 GB disk, 2000 CPU-seconds per day with MySQL database).

Or should we use Heroku, Digital Ocean, Google Cloud, or anything else?

Take care of the case when a user blocks @EditDojo on Twitter

We expect most users NOT to do this, but just in case.

Set up HTTPS on Heroku

When the user finishes the signup flow, we should show them tweets in the language they're fluent in

When a user signs up for the first time, follow their Twitter account from @EditDojo

This is so we can retrieve tweets from their account later. I think it's good to follow them in case their account is private.

Add a readme

Hey @ykdojo,

This sounds like a really cool project judging by the idea described in the video. But the repo doesn't have a readme to give a description. I know the repo doesn't have much to describe as of now, I'll still suggest adding one.

In the landing page, the scrolling animation is too slow (I think)

When the user selects the languages they are learning/fluent in, redirect to a more meaningful page/state

Make a TODO app with Django

I'm actually still in the process of learning Django basics.

I realized I should probably build a simple app like a TODO app first. It will be a prerequisite for building the log in with Twitter function, I think. (Since we'll need to store user data in our database)

So, maybe this will be my next video, instead.

Clarification

Hi ... I wanted to discuss a few things with you. I think you need to mail me at [email protected] since I don't know your mail id.

Take care of the case when we try to follow someone or retrieve tweets