Welcome to TestGlossary

This is the official documentation for the TestGlossary project.

If you have ideas, feel free to get in touch or open an Issue to the project repository.

Commands

make run - start uvicorn server at port 8880
make install - install project dependencies from requirements.txt file
make test - execute all tests
make lint - use linter
make lint - use linter
make help - lists all Makefile commands

Auxiliary commands

make go-prod - start uvicorn server with production environment configuraiton
make gh-deploy - uses the built-in tool of MkDocs (docs here) to deploy documenation to the specific branch that is responsible to handle the GitHub page: thiagojacinto.github.io/test-glossary-project/
make docker-build - build a new Docker image and tag it with timestamp.

Project layout

Makefile        # Makefile with simplifications for project maintenance
mkdocs.yml      # MkDocs configuration file.
log_conf.yaml   # Logging configuraiton file.
.env            # Important environment variables like DATABASE_CONNECTION_STRING
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other documentation related files.
tests/
    ...       # Test related files should be here
testglossary/
    ...       # Main application files must be placed under this directory, following futher structure.

.env files

The development was done considering two environments: production and staging. So, at root directory must exist at least two files named:

- .env
- .staging.env

The content of these files must contain the following variables and its values:

- DATABASE_CONNECTION_STRING    # desired database connection string.
                                # An example could be a DB-as-a-Service implementation like:
                                # Heroku Postgres DBaaS, ElephantSQL

Why documentation?

Documentation matters.

To help with this project goal, TestGlossary uses MkDocs. For full documentation how-to visit mkdocs.org. We highly recommend you to.