|
1 | | -Rovercode Web |
2 | | -============= |
| 1 | +.. .. image:: http://localhost:8000/static/images/screenshot.jpg |
| 2 | +.. image:: https://rovercode.com/static/images/screenshot.jpg |
3 | 3 |
|
4 | | -Block-based programming for educational robots. |
| 4 | +rovercode |
| 5 | +============= |
| 6 | +rovercode-web |
| 7 | +------------- |
5 | 8 |
|
| 9 | +:License: GPLv3 |
| 10 | +.. image:: https://img.shields.io/badge/chat-on%20Slack-41AB8C.svg?style=flat |
| 11 | + :target: http://chat.rovercode.com/ |
| 12 | +.. image:: https://img.shields.io/badge/join-mailing%20list-yellow.svg?style=flat |
| 13 | + :target: http://rovercode.org/cgi-bin/mailman/listinfo/developers |
6 | 14 | .. image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg |
7 | | - :target: https://github.com/pydanny/cookiecutter-django/ |
8 | | - :alt: Built with Cookiecutter Django |
| 15 | + :target: https://github.com/pydanny/cookiecutter-django/ |
| 16 | + :alt: Built with Cookiecutter Django |
| 17 | +.. image:: https://api.travis-ci.org/aninternetof/rovercode-web.svg |
| 18 | + :target: https://travis-ci.org/aninternetof/rovercode-web |
| 19 | +.. image:: https://coveralls.io/repos/github/aninternetof/rovercode-web/badge.svg?branch=development |
| 20 | + :target: https://coveralls.io/github/aninternetof/rovercode-web?branch=deveopment |
9 | 21 |
|
| 22 | +rovercode is easy-to-use package for controlling robots (rovers) that can sense and react to their environment. The Blockly editor makes it easy to program and run your bot straight from your browser. Just drag and drop your commands to drive motors, read values from a variety of supported sensors, and see what your rover sees with the built in webcam viewer. |
| 23 | +rovercode runs on any single-board-computer supported by the `Adafruit Python GPIO wrapper library <https://github.com/adafruit/Adafruit_Python_GPIO>`_, including the NextThingCo CHIP, Raspberry Pi, and BeagleBone Black. Once installed, just connect to your rover and get started. |
10 | 24 |
|
11 | | -:License: GPLv3 |
12 | | - |
| 25 | +**rovercode is made up of two parts.** rovercode-web (this repo) is the web app that is hosted on the Internet. rovercode (`a different repo <https://github.com/aninternetof/rovercode>`_) is the service that runs on the rover. |
13 | 26 |
|
14 | | -Settings |
15 | | --------- |
| 27 | +Setup |
| 28 | +----- |
| 29 | +Install `docker <https://docs.docker.com/engine/installation/>`_ and `docker-compose <https://docs.docker.com/compose/install/>`_, then |
16 | 30 |
|
17 | | -Moved to settings_. |
| 31 | +.. code-block:: bash |
18 | 32 |
|
19 | | -.. _settings: http://cookiecutter-django.readthedocs.io/en/latest/settings.html |
| 33 | + $ git clone --recursive https://github.com/aninternetof/rovercode-web.git && cd rovercode-web |
| 34 | + $ sudo docker-compose -f dev.yml build |
| 35 | + $ sudo docker-compose -f dev.yml up |
| 36 | + $ google-chrome localhost:8000 |
20 | 37 |
|
21 | 38 | Basic Commands |
22 | 39 | -------------- |
| 40 | +rovercode-web runs is built with Django. During development, you can do regular Django things like this: |
23 | 41 |
|
24 | | -Setting Up Your Users |
25 | | -^^^^^^^^^^^^^^^^^^^^^ |
26 | | - |
27 | | -* To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go. |
28 | | - |
29 | | -* To create an **superuser account**, use this command:: |
30 | | - |
31 | | - $ python manage.py createsuperuser |
32 | | - |
33 | | -For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users. |
34 | | - |
35 | | -Test coverage |
36 | | -^^^^^^^^^^^^^ |
37 | | - |
38 | | -To run the tests, check your test coverage, and generate an HTML coverage report:: |
39 | | - |
40 | | - $ coverage run manage.py test |
41 | | - $ coverage html |
42 | | - $ open htmlcov/index.html |
43 | | - |
44 | | -Running tests with py.test |
45 | | -~~~~~~~~~~~~~~~~~~~~~~~~~~ |
46 | | - |
47 | | -:: |
48 | | - |
49 | | - $ py.test |
50 | | - |
51 | | -Live reloading and Sass CSS compilation |
52 | | -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
53 | | - |
54 | | -Moved to `Live reloading and SASS compilation`_. |
55 | | - |
56 | | -.. _`Live reloading and SASS compilation`: http://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html |
57 | | - |
58 | | - |
| 42 | +.. code-block:: bash |
59 | 43 |
|
| 44 | + $ docker-compose -f dev.yml run django python manage.py migrate |
| 45 | + $ docker-compose -f dev.yml run django python manage.py createsuperuser |
60 | 46 |
|
61 | | -Email Server |
62 | | -^^^^^^^^^^^^ |
63 | | - |
64 | | -In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server `MailHog`_ with a web interface is available as docker container. |
65 | | - |
66 | | -.. _mailhog: https://github.com/mailhog/MailHog |
67 | | - |
68 | | -Container mailhog will start automatically when you will run all docker containers. |
69 | | -Please check `cookiecutter-django Docker documentation`_ for more details how to start all containers. |
70 | | - |
71 | | -With MailHog running, to view messages that are sent by your application, open your browser and go to ``http://127.0.0.1:8025`` |
72 | | - |
73 | | - |
74 | | - |
75 | | - |
76 | | -Sentry |
77 | | -^^^^^^ |
78 | | - |
79 | | -Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. |
80 | | -The system is setup with reasonable defaults, including 404 logging and integration with the WSGI application. |
81 | | - |
82 | | -You must set the DSN url in production. |
83 | | - |
84 | | - |
85 | | -Deployment |
86 | | ----------- |
87 | | - |
88 | | -The following details how to deploy this application. |
89 | | - |
90 | | - |
91 | | - |
92 | | -Docker |
93 | | -^^^^^^ |
94 | | - |
95 | | -See detailed `cookiecutter-django Docker documentation`_. |
| 47 | +If anything gives you trouble, see the detailed `cookiecutter-django Docker documentation`_. |
96 | 48 |
|
97 | 49 | .. _`cookiecutter-django Docker documentation`: http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html |
98 | | - |
99 | | - |
0 commit comments