kharayat786/editdojo

Edit Dojo

A web app to improve writing skills in any language.

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!

Installation

These are the steps to install the project on your machine. What we actually need is a virtual environment running Django version 2.1.

1. Install python on your machine. Mac and Ubuntu have it pre-installed. NOTE: you might have Python 2 on your Mac or Linux. If so, make sure to download Python 3. For Windows head on to https://www.python.org/downloads/.
2. Using pip3, the package manager for python, install pipenv using the command below in the terminal.

pip3 install pipenv

3. Open terminal in the folder containing the project files. Install Django version 2.1 in the virtual environment with the following command.

pipenv install django==2.1

4. Go into the virtual environment:

pipenv shell

5. Create a new Django project:

django-admin startproject editdojo_project .

(Note: Don't forget the .(dot) which represents the current diretory in UNIX)

6. Apply migrations

python manage.py makemigrations
python manage.py migrate

7. Run the server:

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

8. 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.

Contributors

See: CONTRIBUTORS