CSC/ECE 517 Spring 2024 - G2400 DevOp for GitHub Miner app: Difference between revisions

From Expertiza_Wiki
Jump to navigation Jump to search
(Created page with "__TOC__ == GitHub Miner == GitHub Miner is a tool for querying GitHub APIs and returning useful information. ==Installation== GitHub Miner is written in Python and can be installed locally using a virtual environment (venv) or using Docker. To use Docker: Ensure that you have Docker installed Update the GITHUB_OAUTH_CLIENT_ID and GITHUB_OAUTH_CLIENT_SECRET values in the docker-compose.yml file based on the instructions here Optionally - add a value for the SECRET_KEY...")
 
(Add additional testing information)
Line 19: Line 19:
The scope of our project was to create a Docker container for the main GitHub miner app and a docker-compose file to run the app and a MySQL container. As such, creating automated tests was not within the scope of our work. Manual tests were completed by:
The scope of our project was to create a Docker container for the main GitHub miner app and a docker-compose file to run the app and a MySQL container. As such, creating automated tests was not within the scope of our work. Manual tests were completed by:


#Running docker compose up.
#Running <pre>docker compose up </pre>
#Verifying that an application container and a mysql container were both created.
#Verifying that an application container and a mysql container were both created.
#Running docker exec ghminer flask db upgrade to migrate the database
#Running <pre>docker exec ghminer flask db upgrade </pre> to migrate the database.
#Running docker exec ghminer python -m backend.scripts.seed_db to seed the database
#Running <pre>docker exec ghminer python -m backend.scripts.seed_db </pre> to seed the database.
#Opening a browser and navigating to http://localhost:5000/test-insert/2/john_doe
#Navigating to http://localhost:5000/test-retrive/2


== Team Members ==
== Team Members ==

Revision as of 23:35, 2 April 2024

GitHub Miner

GitHub Miner is a tool for querying GitHub APIs and returning useful information.


Installation

GitHub Miner is written in Python and can be installed locally using a virtual environment (venv) or using Docker.

To use Docker: Ensure that you have Docker installed Update the GITHUB_OAUTH_CLIENT_ID and GITHUB_OAUTH_CLIENT_SECRET values in the docker-compose.yml file based on the instructions here Optionally - add a value for the SECRET_KEY in the docker-compose.yml file. See the explanation here on secret key values. Run docker compose up.


Testing

The scope of our project was to create a Docker container for the main GitHub miner app and a docker-compose file to run the app and a MySQL container. As such, creating automated tests was not within the scope of our work. Manual tests were completed by:

  1. Running 
    docker compose up
  2. Verifying that an application container and a mysql container were both created.
  3. Running 
    docker exec ghminer flask db upgrade
    to migrate the database.
  4. Running 
    docker exec ghminer python -m backend.scripts.seed_db
    to seed the database.
  5. Opening a browser and navigating to http://localhost:5000/test-insert/2/john_doe
  6. Navigating to http://localhost:5000/test-retrive/2

Team Members

Tanner Neff

Andrew Robie

Srinish Pellakur


Mentor: Jialin Cui

Retrieved from "https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_G2400_DevOp_for_GitHub_Miner_app&oldid=154762"