Commit Graph

17 Commits (peterrauscher/oap-69)

Author SHA1 Message Date
Peter Rauscher 8877c5f85e Added better documentation of API endpoints 2023-04-18 15:41:16 -04:00
Peter Rauscher 2e41d8e36b
Change database build & rebuild behavior, removes RUN_CLEAN option (#59)
* Removed RUN_CLEAN and added scripts for manually rebuilding database, instructions in documentation

* Add cleaning commands as "docker compose run" options, update documentation to reflect changes
2023-04-18 11:09:47 -04:00
Celina Peralta f284809a08
add docs for viewing logs (#63) 2023-04-18 11:04:21 -04:00
Peter Rauscher 10a6ddb31c
Documentation (#58)
* Fixed TOC links

---------

Co-authored-by: eric <eric@hellman.net>
2023-04-16 18:15:55 +00:00
Eric Hellman 684beb0cc2
WIP Documentation (#55)
* fix permissions

* add links to sub-READMEs

* Update .gitignore

* add DO setup info

* Dont clean automatically and move .env to .env.template to avoid overwriting on pulls

* Copy .env.template to .env to satisfy testing reqs

* add log info

* Move deployment instructions to README and improve documentation overall

---------

Co-authored-by: Peter Rauscher <peterrauscher@protonmail.com>
2023-04-15 05:24:48 +00:00
Peter Rauscher 3f05e94e67
Deployment instructions (#53)
* OAP-64: Filter multi-line stopwords and ignore substring matches using regex

* added test case

* Combined api/config.env and database.ini into one root .env file. Needs documentation update!

* Adding default postgres credentials in .env for container tests, needs to be overwritten on DO deployment.

* documentation changes & removed unused scripts

* Documentation changes

* Added deployment instructions and moved .env to example.env

* renaming example.env to .env for test-containers.yml workflow to pass

---------

Co-authored-by: Max Zaremba <max.zaremba@gmail.com>
2023-04-13 19:32:23 +00:00
Peter Rauscher 96718d29d3
Reference Ron's article in README 2023-04-07 14:01:20 +00:00
Peter Rauscher e3ef97cd95
OAP-68: Combine config.env and database.ini (#52)
* OAP-64: Filter multi-line stopwords and ignore substring matches using regex

* added test case

* Combined api/config.env and database.ini into one root .env file. Needs documentation update!

* Adding default postgres credentials in .env for container tests, needs to be overwritten on DO deployment.

* documentation changes & removed unused scripts

---------

Co-authored-by: Max Zaremba <max.zaremba@gmail.com>
2023-04-07 09:37:43 -04:00
Justin O'Boyle 7e4963df77
New setup instructions (#35) 2023-04-06 14:31:18 -04:00
Eric Hellman 966c336b68
improve documentation (#43)
* fix permissions

* add links to sub-READMEs
2023-03-27 12:53:06 -04:00
Justin O'Boyle 535715932d
Setup docker (#26)
* basic config

* Add github action

* Fix makefile for linux and variable python (#27)

* fix makefile

* remove out

* add to gitignore

* Fix makefile for linux and variable python (#27)

* fix makefile

* remove out

* add to gitignore

* Fix dockerfile

* stash changes

* Make makefile dynamic (#28)

* Remove broken docker packages for now

* Add web

* Make Black Formatter happy?

Co-authored-by: Max Zaremba <max.zaremba@gmail.com>
2022-12-13 07:46:08 -05:00
j-sofia ccbdda287e
OAP-17: PostgreSQL integration into API with pg-promise, data function to read from DB, dotenv to read DB credentials from environment variables (#9)
* local db connection and data functions

added pg-promise package to interface with PostgreSQL, added data functions, changed api to port 3001, updated README.md

* pr review changes

* dotenv

* Update README.md with api dependencies

* Update README.md

* PR changes

* typo
2022-10-26 03:07:10 +00:00
Justin O'Boyle 09ec61b7d7
OAP-35 Connect `api/` and `web/`, fix querying between them, add running documentation & make dev environment easier to use (#13) 2022-10-18 08:10:11 -04:00
Justin O'Boyle 962f2d0972
OAP-21 Add project details and dependency maintenance info to README (#10) 2022-10-11 15:54:45 -04:00
Celina Peralta 0f247eac8c
OAP-15, OAP-22: Data ingest + text preprocessing (#6)
* sync upstream

* db skeleton

* update readme

* basic api calls

* api calls

* data ingest + text preprocessing

* update gitignore

* remove lib changes

* lint

* remove unused imports

* gitignore updates

* update python job

* ignore flake8 warnings
2022-10-04 08:22:55 -04:00
Celina Peralta 05d9e73d64
Update README.md 2022-09-27 18:47:21 -04:00
Celina Peralta e139ce9adb
celinanperalta/oap 13 (#3)
* sync upstream

* Add pgsql connection, update pipfile

* add config files

* update gitignore

* remove cached

* remove psycopg2-binary dependency

* add sklearn and pandas to pipfile

* add readme.md
2022-09-27 18:46:58 -04:00