Skip to content

Commit 0747d1f

Browse files
committed
readme update
1 parent 61554bb commit 0747d1f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/webapp/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ In the long-term, look into a way to have the API key --> token conversion be ha
3535

3636
## Databases
3737

38-
All data is stored in MySQL databases (for dev/staging/prod, these are databases in GCP's Cloud SQL), the main file you'll want to look at is [src/webapp/database.py](https://github.com/datakind/sst-app-api/blob/develop/src/webapp/database.py).
38+
All data is stored in MySQL databases for dev/staging/prod, these are databases in GCP's Cloud SQL. In the local environment, the database is sqlite. The main file you'll want to look at for database table definitions is [src/webapp/database.py](https://github.com/datakind/sst-app-api/blob/develop/src/webapp/database.py).
3939

4040
At time of writing, the databases the API cares about and tracks, are as follows:
4141

@@ -50,6 +50,12 @@ At time of writing, the databases the API cares about and tracks, are as follows
5050

5151
NOTE: naming convention is to use a singular descriptor for the table name, however, the "users" table has to follow Laravel's table naming convention, which has the users table called "users".
5252

53+
### Tip
54+
55+
If for any reason you want to manipulate the local database directly during local development or testing, you can do that via the sqlite commandline functionality where you can issue direct sql queries to your local sqlite database https://sqlite.org/cli.html.
56+
57+
The local database is sqlite, the deployed databases in GCP are all mysql.
58+
5359
## Testing
5460

5561
Unit test files are named `<file_under_test>_test.py` to correspond with the files they are testing. Unit tests only test behavior introduced by logic written in those files and do not test any integration with other systems. To respect test isolation, we have the following levels of testing:

0 commit comments

Comments
 (0)