Miguel Barão / aprendizations

Download as
Browse Code »

Commit 3ec494581867f55da273f1c803d2cebabc60072a

Authored by Miguel Barão
1 parent 5d169e97
Exists in master and in 1 other branch dev

fix README.md and gitignore

Showing 2 changed files with 17 additions and 8 deletions   Show diff stats
.gitignore 0 → 100644
  Diff comments   View file @3ec4945
@@ -0,0 +1,5 @@ @@ -0,0 +1,5 @@
  1 +# Specify filepatterns you want git to ignore.
  2 +/aprendizations.egg-info/
  3 +/aprendizations/__pycache__/
  4 +/demo/students.db
  5 +/node_modules/
0 \ No newline at end of file 6 \ No newline at end of file
@@ -79,15 +79,18 @@ At this point aprendizations can be run anywhere with the command `aprendization @@ -79,15 +79,18 @@ At this point aprendizations can be run anywhere with the command `aprendization
79 The user data is maintained in a sqlite3 database file. We first need to create the database: 79 The user data is maintained in a sqlite3 database file. We first need to create the database:
80 80
81 ```sh 81 ```sh
82 -cd aprendizations  
83 -./initdb.py # show current database or initialize empty if nonexisting  
84 -./initdb.py --admin # add admin user  
85 -./initdb.py inscricoes.csv # add students from CSV, passwords are the numbers  
86 -./initdb.py --add 1184 "Aladino da Silva" # add new user (default password=1184)  
87 -./initdb.py --update 1184 --pw alibaba # update password of given student  
88 -./initdb.py --help # for the available options 82 +cd demo
  83 +initdb-aprendizations # show or initialize database
  84 +initdb-aprendizations --admin # add admin user
  85 +initdb-aprendizations inscricoes.csv # add students from CSV
  86 +initdb-aprendizations --add 1184 "Aladino da Silva" # add user
  87 +initdb-aprendizations --update 1184 --pw alibaba # update password
  88 +initdb-aprendizations --help # for the available options
89 ``` 89 ```
90 90
  91 +The default password is equal to the user name used to login.
  92 +
  93 +
91 ### SSL Certificates 94 ### SSL Certificates
92 95
93 We need certificates for https. Certificates can be self-signed or validated by a trusted authority. 96 We need certificates for https. Certificates can be self-signed or validated by a trusted authority.
@@ -141,7 +144,8 @@ and then copy the `cert.pem` and `privkey.pem` files to `aprendizations/certs` d @@ -141,7 +144,8 @@ and then copy the `cert.pem` and `privkey.pem` files to `aprendizations/certs` d
141 The application includes a small example in `demo/demo.yaml`. Run it with 144 The application includes a small example in `demo/demo.yaml`. Run it with
142 145
143 ```sh 146 ```sh
144 -./serve.py demo/demo.yaml 147 +cd demo
  148 +aprendizations demo.yaml
145 ``` 149 ```
146 150
147 and open a browser at [https://127.0.0.1:8443](). If it everything looks good, check at the correct address `https://www.example.com` (requires port forward in the firewall). The option `--debug` provides more verbose logging and might be useful during testing. 151 and open a browser at [https://127.0.0.1:8443](). If it everything looks good, check at the correct address `https://www.example.com` (requires port forward in the firewall). The option `--debug` provides more verbose logging and might be useful during testing.