Skip to content

Commit a959f2f

Browse files
author
Luis Riera
committed
Added new setup instructions to the REAMDME and deleted old, outdated setup instructions
1 parent bffaeef commit a959f2f

File tree

1 file changed

+24
-22
lines changed

1 file changed

+24
-22
lines changed

README.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
1-
## Important things to know before developing locally or in C9
1+
**Requirements**
2+
- Python2.7
3+
- linux, unix, mac, windows(with attachments), Ubuntu
4+
- virtualenv
5+
- mysql and python mysql-db
26

3-
- You will notice a bunch of sqlite related code, but we are no longer using sqlite
4-
- You will need to have mysql and python mysql-db
5-
6-
# c9 Installation Guide #
7-
8-
1. Create a work space in c9 with the python template and the github ssh url.
9-
2. run `git pull` to ensure latest changes are pulled.
10-
3. run `source setup.sh` to execute setup script.
11-
4. run `phpmyadmin-ctl install` to run the phpmyadmin client.
12-
5. navigate to the phpmyadmin interface
13-
6. create a database named `urcpp_flask_v2`
14-
7. add a user named `urcpp-flask` with password `DanforthLabor123!` and check `grant all permissions on database urcpp_flask_v2`
15-
- See instructions [here](https://docs.google.com/document/d/1K2Ex8xsa65SwvCG3UdZ9bL-hLey9rTguOA9kfbENtwY/edit?usp=sharing) for more aid
16-
8. comment out lines 20-27 in `api/__init__.py`
17-
9. create a file `api/secret_key` with alphanumeric characters in the file
18-
9. run `python recreate_static`
19-
10. run `python recreate_dynamic`
20-
11. comment lines 20-27 back in
21-
12. run `python api.py`
22-
13. if application does not load, comment out lines 80-83 in 'urcpp-flask/api/everything.py'
23-
14. to initialize mysql, run 'mysql-ctl install' and answer 'Y'
7+
**Setup**
8+
1. In your working environment, clone the URCPP Repo:
9+
`https://github.com/BCStudentSoftwareDevTeam/urcpp` as of 02/10/2022
10+
2. Pull the most recent changes
11+
3. In the file `setup.sh` add lineRun `source setup.sh`
12+
4. Go to your Phpmyadmin interface and log in with your credentials
13+
- Located here: `http://0.0.0.0/phpmyadmin/`
14+
- Make sure to replace 0.0.0.0 with your server's IP address
15+
5. Create a new database named `urcpp_flask_v2`
16+
- If a database of that name already exists, drop it and create it again
17+
6. Create a user named `urcpp-flask` with password `DanforthLabor123!`
18+
7. Grant all permissions on the database `urcpp_flask_v2` to `urcpp-flask`
19+
8. Create a file named `secret_key` in the `api` folder
20+
- `secret_key` MUST contain some alphanumeric characters. Anything will work including `AnythignWillWork`
21+
9. Comment out lines 20-27 in `api/__init__.py`
22+
10. Run `python recreate_static.py`
23+
11. Run `python recreate_dynamic.py`
24+
12. Comment lines 20-27 in `api/__init__.py` back in
25+
13. Run `python api.py`

0 commit comments

Comments
 (0)