Blame view

README.md 2.07 KB
43785de6   Miguel Barão   - added documenta...
1
# Get Started
a96cd2c7   Miguel Barão   - added logging s...
2

1e8f0810   Miguel Barão   update setup.py a...
3

5d859a41   Miguel Barão   update documentation
4
5
6
## Requirements

We will need to install python3.6 with sqlite3 support.
93e13002   Miguel Barão   updates README.md.
7
This can be done using the system package management, downloaded from [http://www.python.org](), or compiled from sources.
a96cd2c7   Miguel Barão   - added logging s...
8

39126690   Miguel Barão   removes npm and n...
9
10
11
12
- Installing from the system package management:
    - OSX: `port install python36`
    - FreeBSD: `pkg install python36 py36-sqlite3`
    - Linux: `apt-get install ???`
f540e673   Miguel Barão   - added README.md
13
- Installing from sources:
5d859a41   Miguel Barão   update documentation
14
15
    - Download from [http://www.python.org]()
    - `unxz Python-3.6.tar.xz`
39126690   Miguel Barão   removes npm and n...
16
    - `tar xvf Python-3.6.tar`
443a1eea   Miguel Barão   Update to latest ...
17
    - `cd Python-3.6`
39126690   Miguel Barão   removes npm and n...
18
    - `./configure --prefix=$HOME/.local/bin`
5d859a41   Miguel Barão   update documentation
19
20
    - `make && make install`

43785de6   Miguel Barão   - added documenta...
21
Next install pip (if not yet installed):
39126690   Miguel Barão   removes npm and n...
22

43785de6   Miguel Barão   - added documenta...
23
    python36 -m ensurepip --user
39126690   Miguel Barão   removes npm and n...
24
25

This will install pip in your account under `~/.local/bin`.
c54ee176   Miguel Barão   update javascript...
26
27
In the end you should be able to run `pip3 --version` and `python3 -c "import sqlite3"` without errors (sometimes `pip3` is `pip`, `pip3.6` or `pip-3.6`).

39126690   Miguel Barão   removes npm and n...
28
29
Install additional python packages locally on the user area:

1e8f0810   Miguel Barão   update setup.py a...
30
    pip install --user tornado sqlalchemy pyyaml pygments markdown bcrypt
93e13002   Miguel Barão   updates README.md.
31
32

These are usually installed under
43785de6   Miguel Barão   - added documenta...
33

59213008   Miguel Barão   - fixed user path...
34
- OSX: `~/Library/python/3.6/lib/python/site-packages/`
443a1eea   Miguel Barão   Update to latest ...
35
- Linux/FreeBSD: `~/.local/lib/python3.6/site-packages/`
a96cd2c7   Miguel Barão   - added logging s...
36

43785de6   Miguel Barão   - added documenta...
37
Note: If you want to always install python modules on the user account, edit the pip configuration file `~/.config/pip/pip.conf` (FreeBSD, Linux) or `Library/Application Support/pip/pip.conf` (OSX) and add the lines
39126690   Miguel Barão   removes npm and n...
38
39

    [global]
1e8f0810   Miguel Barão   update setup.py a...
40
    user = yes
43785de6   Miguel Barão   - added documenta...
41

f540e673   Miguel Barão   - added README.md
42
## Installation
443a1eea   Miguel Barão   Update to latest ...
43
44

Replace USER by your bitbucket username:
39126690   Miguel Barão   removes npm and n...
45

5d859a41   Miguel Barão   update documentation
46
    cd path/to/some/directory
1e8f0810   Miguel Barão   update setup.py a...
47
48
49
50
51
    git clone https://USER@bitbucket.org/USER/aprendizations.git

A directory aprendizations will be created with the software:

    cd aprendizations
5dae401a   Miguel Barão   update README.md
52

f540e673   Miguel Barão   - added README.md
53
## Configuration
43785de6   Miguel Barão   - added documenta...
54
55
56
57

First we need to create a database:

    ./initdb.py                 # initialize with a single user `0`  and empty password
f540e673   Miguel Barão   - added README.md
58
    ./initdb.py --help          # for the available options
39126690   Miguel Barão   removes npm and n...
59

f540e673   Miguel Barão   - added README.md
60
We also need certificates for https. Generate selfsigned certificates using openssl:
43785de6   Miguel Barão   - added documenta...
61

39126690   Miguel Barão   removes npm and n...
62
    cd certs
43785de6   Miguel Barão   - added documenta...
63
    openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes
f540e673   Miguel Barão   - added README.md
64
    cd ..
c3eba869   Miguel Barão   update README.md
65

a96cd2c7   Miguel Barão   - added logging s...
66
Run a demonstration:
443a1eea   Miguel Barão   Update to latest ...
67

1e8f0810   Miguel Barão   update setup.py a...
68
    ./serve.py
a96cd2c7   Miguel Barão   - added logging s...

443a1eea   Miguel Barão   Update to latest ...

39126690   Miguel Barão   removes npm and n...

f540e673   Miguel Barão   - added README.md

39126690   Miguel Barão   removes npm and n...

5dae401a   Miguel Barão   update README.md

93e13002   Miguel Barão   updates README.md.

1e8f0810   Miguel Barão   update setup.py a...

5dae401a   Miguel Barão   update README.md

93e13002   Miguel Barão   updates README.md.

b4ceb7fc   Miguel Barão   minor change in l...

93e13002   Miguel Barão   updates README.md.

39126690   Miguel Barão   removes npm and n...

93e13002   Miguel Barão   updates README.md.

f540e673   Miguel Barão   - added README.md

59213008   Miguel Barão   - fixed user path...

443a1eea   Miguel Barão   Update to latest ...

c288f8c6   Miguel Barao   - updated documen...

443a1eea   Miguel Barão   Update to latest ...

c288f8c6   Miguel Barao   - updated documen...

93e13002   Miguel Barão   updates README.md.

f540e673   Miguel Barão   - added README.md

b4ceb7fc   Miguel Barão   minor change in l...

59213008   Miguel Barão   - fixed user path...

43785de6   Miguel Barão   - added documenta...

59213008   Miguel Barão   - fixed user path...

93e13002   Miguel Barão   updates README.md.

bbc1c506   Miguel Barão   - documentation u...

43785de6   Miguel Barão   - added documenta...

443a1eea   Miguel Barão   Update to latest ...

5d859a41   Miguel Barão   update documentation

43785de6   Miguel Barão   - added documenta...

bbc1c506   Miguel Barão   - documentation u...

443a1eea   Miguel Barão   Update to latest ...

bbc1c506   Miguel Barão   - documentation u...

43785de6   Miguel Barão   - added documenta...

93e13002   Miguel Barão   updates README.md.

43785de6   Miguel Barão   - added documenta...

bbc1c506   Miguel Barão   - documentation u...

443a1eea   Miguel Barão   Update to latest ...

bbc1c506   Miguel Barão   - documentation u...

43785de6   Miguel Barão   - added documenta...

443a1eea   Miguel Barão   Update to latest ...

43785de6   Miguel Barão   - added documenta...

bbc1c506   Miguel Barão   - documentation u...

5d859a41   Miguel Barão   update documentation

443a1eea   Miguel Barão   Update to latest ...

39126690   Miguel Barão   removes npm and n...

5d859a41   Miguel Barão   update documentation

93e13002   Miguel Barão   updates README.md.

c55940af   Miguel Barão   - minor change in...

39126690   Miguel Barão   removes npm and n...

443a1eea   Miguel Barão   Update to latest ...

f540e673   Miguel Barão   - added README.md

43785de6   Miguel Barão   - added documenta...

3ec49458   Miguel Barão   fix README.md and...

39126690   Miguel Barão   removes npm and n...

43785de6   Miguel Barão   - added documenta...

59213008   Miguel Barão   - fixed user path...

443a1eea   Miguel Barão   Update to latest ...

93e13002   Miguel Barão   updates README.md.

443a1eea   Miguel Barão   Update to latest ...

c288f8c6   Miguel Barao   - updated documen...

59213008   Miguel Barão   - fixed user path...

443a1eea   Miguel Barão   Update to latest ...

59213008   Miguel Barão   - fixed user path...

43785de6   Miguel Barão   - added documenta...

93e13002   Miguel Barão   updates README.md.

43785de6   Miguel Barão   - added documenta...

59213008   Miguel Barão   - fixed user path...

5d859a41   Miguel Barão   update documentation

59213008   Miguel Barão   - fixed user path...

43785de6   Miguel Barão   - added documenta...

59213008   Miguel Barão   - fixed user path...

43785de6   Miguel Barão   - added documenta...

59213008   Miguel Barão   - fixed user path...

43785de6   Miguel Barão   - added documenta...

59213008   Miguel Barão   - fixed user path...

ea4ff4d2   Miguel Barão   - radio: added su...

59213008   Miguel Barão   - fixed user path...

39126690   Miguel Barão   removes npm and n...

93e13002   Miguel Barão   updates README.md.

39126690   Miguel Barão   removes npm and n...

443a1eea   Miguel Barão   Update to latest ...

39126690   Miguel Barão   removes npm and n...

a203d3cc   Miguel Barão   - new http server...

5d859a41   Miguel Barão   update documentation

39126690   Miguel Barão   removes npm and n...

5d859a41   Miguel Barão   update documentation

59213008   Miguel Barão   - fixed user path...

443a1eea   Miguel Barão   Update to latest ...

5dae401a   Miguel Barão   update README.md

43785de6   Miguel Barão   - added documenta...

443a1eea   Miguel Barão   Update to latest ...

5dae401a   Miguel Barão   update README.md

43785de6   Miguel Barão   - added documenta...

443a1eea   Miguel Barão   Update to latest ...

43785de6   Miguel Barão   - added documenta...

443a1eea   Miguel Barão   Update to latest ...

59213008   Miguel Barão   - fixed user path...

443a1eea   Miguel Barão   Update to latest ...

5dae401a   Miguel Barão   update README.md

59213008   Miguel Barão   - fixed user path...

443a1eea   Miguel Barão   Update to latest ...

59213008   Miguel Barão   - fixed user path...

43785de6   Miguel Barão   - added documenta...

f75a344f   Miguel Barão   - README.md updat...

443a1eea   Miguel Barão   Update to latest ...

db04e658   Miguel Barão   - added option to...

43785de6   Miguel Barão   - added documenta...

f75a344f   Miguel Barão   - README.md updat...

93e13002   Miguel Barão   updates README.md.

f75a344f   Miguel Barão   - README.md updat...

43785de6   Miguel Barão   - added documenta...

d187aad4   Miguel Barão   - adds courses

43785de6   Miguel Barão   - added documenta...

f75a344f   Miguel Barão   - README.md updat...

d187aad4   Miguel Barão   - adds courses

f75a344f   Miguel Barão   - README.md updat...

43785de6   Miguel Barão   - added documenta...

93e13002   Miguel Barão   updates README.md.

f75a344f   Miguel Barão   - README.md updat...

93e13002   Miguel Barão   updates README.md.

443a1eea   Miguel Barão   Update to latest ...

f75a344f   Miguel Barão   - README.md updat...

93e13002   Miguel Barão   updates README.md.

443a1eea   Miguel Barão   Update to latest ...

93e13002   Miguel Barão   updates README.md.