03 - Exploring an unknown project

This script has some questions with the aim of guiding the exploration of the code and documenting its findings. You can also apply it for any other poorly documented project you need to work on in the future.

Download the project code to be analyzed here and follow the questions. They are a guide to how to explore a project that you do not know.

Dependencies and services used

Question

What technologies are used in code? In addition to the programming language, also list the external libraries/modules used.

Question

The application uses a database. Which manager? Where does the application search for the database? What are the tables used? How are they created?

The initial deploy

Question

Does the application use authentication? If so, which guy? How are users created? Is there an administrator user? How is password security done? What is the default password?

Question

What commands did you use to run the application? Write everyone from creating the database and users to the full operation of the project.

Question

Now that you can run the application, explore it a bit and describe in a few phrases for what it serves.

Project Documentation

Question

If you were to create a user guide (student) for this application, what tasks would you describe?

Question

If you were to create a user guide (teacher) for this application, what tasks would you describe?

Question

What would you describe in a developer guide for this application?