Codebase
Navigate the Codebase using the tree view. Use the filters to highlight where various files are grouped to aid understanding.
Getting Started Commands
Project Structure
Below is a short description of the key directories of the project to aid you when understanding where key files are located.
.dockerignore - A file that specifies which files to ignore when building a Docker image.
.github/ - This directory contains GitHub-specific configuration files, such as workflows for automating builds and tests.
.github/workflows/ - A subdirectory containing YAML files that define GitHub Actions workflows.
.github/workflows/build.yml - A workflow file that defines the steps to build and test the application.
.gitignore - A file that specifies which files to ignore when committing to a Git repository.
app/ - The main application directory.
app/package.json - A file containing metadata about the application, such as its dependencies and scripts.
app/spec/ - A directory for writing tests for the application.
app/spec/persistence/ - A subdirectory for testing the application's data persistence layer.
app/spec/persistence/sqlite.spec.js - A test file for the SQLite database.
app/spec/routes/ - A subdirectory for testing the application's routes.
app/spec/routes/addItem.spec.js, app/spec/routes/deleteItem.spec.js, app/spec/routes/getItems.spec.js, app/spec/routes/updateItem.spec.js - Test files for the various routes in the application.
app/src/ - The source code directory for the application.
app/src/index.js - The main JavaScript file for the application.
app/src/persistence/ - A subdirectory for the application's data persistence layer.
app/src/persistence/index.js - The main persistence module.
app/src/persistence/mysql.js, app/src/persistence/sqlite.js - Modules for connecting to MySQL and SQLite databases, respectively.
app/src/routes/ - A subdirectory for the application's routes.
app/src/routes/addItem.js, app/src/routes/deleteItem.js, app/src/routes/getItems.js, app/src/routes/updateItem.js - The source code for the various routes in the application.
app/src/static/ - A directory for static assets, such as images, stylesheets, and JavaScript files.
app/src/static/css/ - A subdirectory for CSS files.
app/src/static/css/bootstrap.min.css, app/src/static/css/styles.css - Stylesheets for the application.
app/src/static/css/font-awesome/ - A subdirectory for Font Awesome icons.
app/src/static/css/font-awesome/*.min.css, app/src/static/css/font-awesome/*.eot, app/src/static/css/font-awesome/*.svg, app/src/static/css/font-awesome/*.ttf, app/src/static/css/font-awesome/*.woff, app/src/static/css/font-awesome/*.woff2 - Various Font Awesome files.
app/src/static/index.html - The HTML file for the application.
app/src/static/js/ - A subdirectory for JavaScript files.
app/src/static/js/app.js, app/src/static/js/babel.min.js, app/src/static/js/react-bootstrap.js, app/src/static/js/react-dom.production.min.js, app/src/static/js/react.production.min.js - JavaScript files for the application.
app/yarn.lock - A file that locks the versions of the application's dependencies.
build.sh - A shell script for building the application.
docker-compose.yml - A file that defines the services and their configurations for a Docker Compose application.
Dockerfile - A file that defines how to build a Docker image for the application.
LICENSE - A file containing the license for the application.
mkdocs.yml - A file for configuring MkDocs, a static site generator.
README.md - A file containing information about the application, such as its purpose, installation instructions, and usage.
requirements.txt - A file listing the Python dependencies for the application.
