Skip to content

Commit 859bd4b

Browse files
committed
modified the installation guide and readme with new links
1 parent 96b9d6e commit 859bd4b

File tree

2 files changed

+26
-22
lines changed

2 files changed

+26
-22
lines changed

README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
#Mobile App Control Center (MACC)
22
MACC is a backend platform for the Peace Corps mobile applications - Malaria and FirstAide. The Mobile App Control Center allows the volunteers at Peace Corps HQ to send or edit any information in their mobile applications through a set of APIs.
33

4-
If you already had the server installed, it is advised that you delete the current database to remove errors related to the model fields updates. this can be done by running the following command:
5-
6-
`python manage.py flush`
74

85
#On Malaria App
96
MACC works on Malaria Prevention application as infoHub, a portal where posts can be added and notified to the mobile app users(volunteers). Posts on infoHub mainly focus on malaria prevention tips and malaria awareness.
@@ -13,5 +10,7 @@ MACC works on PCSA mobile and web apps, MACC makes the mobile apps fully dynamic
1310

1411

1512
Installation Guide - [here](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md)
13+
1614
API Documentation - [here](https://docs.google.com/document/d/1uQ42HQGIEOWoD-PtRRGoKLN15S-EhEkWgsIxiceNMGI/edit?usp=sharing)
17-
Contribution Guide = [here](https://github.com/systers/macc/blob/develop/docs/Contribution.md)
15+
16+
Contribution Guide - [here](https://github.com/systers/macc/blob/develop/docs/Contribution.md)

docs/Installation Guide.md

+23-18
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@
44
This tutorial assumes that the user is installing and running the project under the Ubuntu Virtual Machine that is provided by PeaceCorps.
55

66
## Table of Contents
7-
1. [Install git](https://github.com/systers/app-web-server/blob/develop/docs/Installation%20Guide.md#install-git)
8-
2. [Clone Project](https://github.com/systers/app-web-server/blob/develop/docs/Installation%20Guide.md#clone-project)
9-
3. [Install Django and PostgreSQL](https://github.com/systers/app-web-server/blob/develop/docs/Installation%20Guide.md#install-django-and-postgresql)
10-
4. [Install VirtualBox and Vagrant](https://github.com/systers/app-web-server/blob/develop/docs/Installation%20Guide.md#install-virtualbox-and-vagrant)
11-
5. [Download PeaceCorps Ubuntu Virtual Machine](https://github.com/systers/app-web-server/blob/develop/docs/Installation%20Guide.md#download-peacecorps-ubuntu-virtual-machine)
12-
6. [Using Vagrant](https://github.com/systers/app-web-server/blob/develop/docs/Installation%20Guide.md#using-vagrant)
13-
7. [Install Project Dependencies](https://github.com/systers/app-web-server/blob/develop/docs/Installation%20Guide.md#install-project-dependencies)
14-
8. [Setup PostgreSQL](https://github.com/systers/app-web-server/blob/develop/docs/Installation%20Guide.md#setup-postgresql)
15-
9. [Update settings.py](https://github.com/systers/app-web-server/blob/develop/docs/Installation%20Guide.md#update-settingspy)
16-
10. [Generate Database Tables Corresponding to Django Models](https://github.com/systers/app-web-server/blob/develop/docs/Installation%20Guide.md#generate-database-tables-corresponding-to-django-models)
17-
11. [Run Development Server](https://github.com/systers/app-web-server/blob/develop/docs/Installation%20Guide.md#run-development-server)
18-
12. [Try out Mobile App Control Center](https://github.com/systers/app-web-server/blob/develop/docs/Installation%20Guide.md#try-out-mobile-app-control-center)
19-
13. [Exit the Virtual Machine](https://github.com/systers/app-web-server/blob/develop/docs/Installation%20Guide.md#exit-the-virtual-machine)
7+
1. [Install git](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md#install-git)
8+
2. [Clone Project](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md#clone-project)
9+
3. [Install Django and PostgreSQL](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md#install-django-and-postgresql)
10+
4. [Install VirtualBox and Vagrant](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md#install-virtualbox-and-vagrant)
11+
5. [Download PeaceCorps Ubuntu Virtual Machine](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md#download-peacecorps-ubuntu-virtual-machine)
12+
6. [Using Vagrant](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md#using-vagrant)
13+
7. [Install Project Dependencies](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md#install-project-dependencies)
14+
8. [Setup PostgreSQL](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md#setup-postgresql)
15+
9. [Update settings.py](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md#update-settingspy)
16+
10. [Generate Database Tables Corresponding to Django Models](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md#generate-database-tables-corresponding-to-django-models)
17+
11. [Run Development Server](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md#run-development-server)
18+
12. [Try out Mobile App Control Center](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md#try-out-mobile-app-control-center)
19+
13. [Exit the Virtual Machine](https://github.com/systers/macc/blob/develop/docs/Installation%20Guide.md#exit-the-virtual-machine)
2020

2121
## Install git
2222

@@ -28,15 +28,15 @@ Clone the project from GitHub by running the following command:
2828

2929
git clone project_url_here
3030

31-
For my project, this would correspond to:
31+
For our project, this would correspond to:
3232

33-
git clone git@github.com:systers/app-web-server.git
33+
git clone https://github.com/systers/macc.git
3434

3535
## Install Django and PostgreSQL
3636

3737
If you are installing and running the project on your local machine and not on the PeaceCorps VM, then you will need to download and install the following software:
3838

39-
1. [Django](https://www.djangoproject.com/download/) (version >= 1.6.5)
39+
1. [Django](https://www.djangoproject.com/download/) (version == 1.6.5)
4040
2. [PostgreSQL](http://www.postgresql.org/download/) (version >= 9.3.4)
4141

4242
Skip the next two sections if not using the PeaceCorps VM and jump to the section '**Install Project Dependencies**'.
@@ -57,7 +57,7 @@ Install VirtualBox and Vagrant by running the installers.
5757

5858
## Download PeaceCorps Ubuntu Virtual Machine
5959

60-
A Vagrant file is located in the top level directory for the project (at [https://github.com/systers/app-web-server/blob/develop/Vagrantfile](https://github.com/systers/app-web-server/blob/develop/Vagrantfile) found on GitHub. In case you do not have a copy of this Vagrant file, here are it's contents:
60+
A Vagrant file is located in the [top level directory for the project.](https://github.com/systers/macc/blob/develop/Vagrantfile) found on GitHub. In case you do not have a copy of this Vagrant file, here are it's contents:
6161
```
6262
# -*- mode: ruby -*-
6363
# vi: set ft=ruby :
@@ -283,6 +283,12 @@ Username: admin
283283
Email: your email
284284
Password: mypassword
285285
```
286+
287+
If the models are updated in any way, you need to delete the database and then migrating the fields once more. This can be done by:
288+
289+
python manage.py flush
290+
python manage.py syncdb
291+
286292
Check that the tables were created by starting the postgres client and viewing the tables using the `\dt` command.
287293
```
288294
psql -U myuser -d webapp -h localhost -W
@@ -324,7 +330,6 @@ Location: Your location
324330
Phone: Your phone number
325331
Gender: Your gender
326332
Reset pass: 1 (not sure what this field does)
327-
Imageobj: Pick any random image from your computer
328333
Verified: 1 (not sure what this field does)
329334
```
330335
Click on `Save` and logout.

0 commit comments

Comments
 (0)