Permalink
Browse files

added readme + license

  • Loading branch information...
joelewis committed Dec 22, 2018
1 parent 882da13 commit fe42045616df0a54bdef8993d0f6228354e6ddb3
Showing with 130 additions and 6,189 deletions.
  1. +7 −0 LICENSE
  2. +40 −0 README.md
  3. +1 −203 client/public/js/0.bundle.js
  4. +1 −15 client/public/js/2.bundle.js
  5. +1 −15 client/public/js/3.bundle.js
  6. +1 −15 client/public/js/4.bundle.js
  7. +79 −5,941 client/public/js/bundle.js
@@ -0,0 +1,7 @@
Copyright 2018 Joe Lewis<lewis.joe.18@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,40 @@
# What is Writango?

Writango is a tool to write something and publish it as a playable article. [There's a demo here.](http://writango.com/writes/@joelewis/play/whats-writango-1596183143) It could be considered as an article that could be presented like a presentation.

# Installation Guide
Writango is a [Python / Django](https://www.djangoproject.com/) project.
The front-end is written with [React](https://www.djangoproject.com/). Being a Django project you can use your database of choice. Just configure settings.py to suit your needs. It runs using SQLite by default. [Look here](https://github.com/joelewis/writango/blob/master/server/writango_project/sample_settings.py) for sample settings.py.


```
git clone https://github.com/joelewis/writango
cd writango
virtualenv venv
pip install -r requirements.txt
# Edit sample_settings.py to suit your needs and rename it to settings.py.
cd server/
python manage.py makemigrations
python manage.py migrate
python manage.py runserver
cd ../client/
npm install # make sure you've got the right version of node & NPM
webpack --config webpack.config.js --watch # use webpack.config.production.js for production compiling
```

If you visit http://localhost:8000, you should be able to reach your Writango instance.

# Roadmap
Refer [TODO.txt](https://github.com/joelewis/writango/blob/master/TODO.txt) to refer things in pipeline. If you are familiar with Python or React and/or simply interested in the project, do help complete the TODO.


# LICENSE
MIT License.

Pull requests are welcome. Use github issues to file bugs and other queries.


Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Some generated files are not rendered by default. Learn more.

Oops, something went wrong.
Oops, something went wrong.

0 comments on commit fe42045

Please sign in to comment.