Finishing touches

Author: filippos47

README.md

@@ -1,8 +1,10 @@
 # Elon-Charge
 
-Elon-Charge is a platform that connects electric vehicle drivers and electric
-station operators. Drivers and operators can view and manage their cars and
-stations get personalized analytics about their past charges.
+Elon-Charge is a platform that aims to connect electric vehicle drivers and
+electric station operators. Both parties can get personalised analytics and
+statistics regarding past EV charges, navigating through a stripped-down,
+to-the-point UI. Specialized administrative operations can also be performed
+through a no-nonsense CLI interface.
 
 ## Setting up
 
@@ -13,18 +15,18 @@ Please follow the instructions on the [deployment](deployment) directory.
 * [Back End](back-end): The implementation of the REST API written in
   Python/Django.
 * [Front End](front-end): The front end of the application written in React.
-* [CLI Client](cli-client): A CLI tool written in Python that interfaces
-  with the REST API.
+* [CLI Client](cli-client): A CLI tool written in Python (using `argparse` module)
+  that interfaces with the REST API.
 
 ## Documentation
 
 The [documentation](documentation) directory contains the documentation for
-elon-charge. Specifically, it contains [UML diagrams](documentation/static_v2) in `.pdf` format
-and the {Software,Stakeholders} Requirements Specifications.
+Elon-Charge. Specifically, it contains [UML diagrams](documentation/static_v2)
+in `.pdf` format and the {Software,Stakeholders} Requirements Specifications.
 
 ## Authors
 
-Alphabetically.
+Alphabetically,
 
 * Dionysios Ntelis
 * Filippos Malandrakis

cli-client/cli/__main__.py

@@ -55,17 +55,17 @@ def main():
         parents=[format_parser, apikey_parser])
     sessions_per_point_parser.add_argument(
         "--point",
-        help="specify point",
+        help="specify point [<ID>]",
         required=True
     )
     sessions_per_point_parser.add_argument(
         "--datefrom",
-        help="enter starting date of interval",
+        help="enter starting date of interval [YYYY-MM-DD hh:mm:ss]",
         required=True
     )
     sessions_per_point_parser.add_argument(
         "--dateto",
-        help="enter ending date of interval",
+        help="enter ending date of interval [YYYY-MM-DD hh:mm:ss]",
         required=True
     )
 
@@ -74,17 +74,17 @@ def main():
         parents=[format_parser, apikey_parser])
     sessions_per_station_parser.add_argument(
         "--station",
-        help="specify station",
+        help="specify station [<ID>]",
         required=True
     )
     sessions_per_station_parser.add_argument(
         "--datefrom",
-        help="enter starting date of interval",
+        help="enter starting date of interval [YYYY-MM-DD hh:mm:ss]",
         required=True
     )
     sessions_per_station_parser.add_argument(
         "--dateto",
-        help="enter ending date of interval",
+        help="enter ending date of interval [YYYY-MM-DD hh:mm:ss]",
         required=True
     )
 
@@ -93,17 +93,17 @@ def main():
         parents=[format_parser, apikey_parser])
     sessions_per_ev_parser.add_argument(
         "--ev",
-        help="specify ev",
+        help="specify ev [<LICENSE-PLATE>]",
         required=True
     )
     sessions_per_ev_parser.add_argument(
         "--datefrom",
-        help="enter starting date of interval",
+        help="enter starting date of interval [YYYY-MM-DD hh:mm:ss]",
         required=True
     )
     sessions_per_ev_parser.add_argument(
         "--dateto",
-        help="enter ending date of interval",
+        help="enter ending date of interval [YYYY-MM-DD hh:mm:ss]",
         required=True
     )
 

deployment/README.md

@@ -45,13 +45,13 @@ REACT_ENV_FILE="$DIR/front-end/.env"
 
 Upon review, just execute the deployment script:
 ```bash
-bash deploy.sh
+bash fireitup.sh
 ```
 
 One last step to use the cli-client, is to activate the virtual environment in
 which the script installed it. To do so, execute:
 ```bash
-source `git rev-parse --show-toplevel`/.venv/bin/activate`
+source /path/to/eloncharge/.venv/bin/activate`
 ```
 
 You can now navigate to `https://eloncharge.gr`. You can also administer the app
@@ -75,7 +75,7 @@ is documented below.
 2. Set up virtual environment
 
     ```bash
-    $ cd `git rev-parse --show-toplevel`
+    $ cd /path/to/eloncharge
     $ python3 -m venv .venv
     $ source .venv/bin/activate
     $ pip3 install -r deployment/requirements.txt
@@ -92,30 +92,30 @@ is documented below.
 4. Set up backend
 
     ```bash
-    $ cd `git rev-parse --show-toplevel`/back-end
+    $ cd /path/to/eloncharge/back-end
     $ cp backend/settings_test.py backend/settings.py
     $ python3 manage.py migrate
     $ python3 manage.py populatedb-demo
     ```
 5. Set up frontend
 
     ```bash
-    $ cd `git rev-parse --show-toplevel`/front-end
+    $ cd /path/to/eloncharge/front-end
     $ npm install
     ```
 
 6. Set up cli-client
 
     ```bash
-    $ cd `git rev-parse --show-toplevel`/cli-client
+    $ cd /path/to/eloncharge/cli-client
     $ python3 setup.py build
     $ python3 setup.py install
     ```
 
 7. Set up NGINX reverse proxy
 
     ```bash
-    $ cd `git rev-parse --show-toplevel`/deployment
+    $ cd /path/to/eloncharge/deployment
     $ sudo cp -r ssl/* /etc/ssl
     $ sudo cp nginx/eloncharge /etc/nginx/sites-available/eloncharge
     $ sudo ln -sn /etc/nginx/sites-available/eloncharge /etc/nginx/sites-enabled/eloncharge
@@ -134,13 +134,13 @@ is documented below.
 1. Fire up React server
 
     ```bash
-    $ cd `git rev-parse --show-toplevel`/front-end
+    $ cd /path/to/eloncharge/front-end
     $ nohup npm start &
     ```
 
 2. Fire up Django application through Gunicorn
 
     ```bash
-    $ cd `git rev-parse --show-toplevel`/back-end
+    $ cd /path/to/eloncharge/back-end
     $ nohup gunicorn --access-logfile - --workers 3 --bind 127.0.0.1:8000 backend.wsgi &
     ```

deployment/fireitup.sh

@@ -7,7 +7,7 @@ echo "2. PSQL db pass set inside \$DJANGO_CUSTOM_SETTINGS file is same with actu
 echo "   db password, \$DB_PASS"
 
 while true; do
-    read -p "Do you wish to install this program? [y/n]" yn
+    read -p "Do you wish to proceed with this operation? [y/n]" yn
     case $yn in
         [Yy] ) break;;
         * ) exit;;