mybuddy/docs/contributing.md

Contributing

Baby Buddy's maintainers accept and encourage contributions via GitHub Issues and Pull Requests. Maintainers and users may also be found at babybuddy/Lobby on Gitter.

Pull request process

1. Fork this repository and commit your changes.
2. Make and commit tests for any new features or major functionality changes.
3. Run gulp lint and gulp test (see Gulp Commands) and ensure that all tests pass.
4. Updated static assets if necessary and commit the /static folder (see gulp updatestatic).
5. Open a new pull request against the master branch.

Maintainers will review new pull requests will as soon as possible, and we will do our best to provide feedback and support potential contributors.

Translation

POEditor

Baby Buddy uses POEditor for translation contributions. Interested contributors can join translation of Baby Buddy for access to a simple, web-based frontend for adding/editing translation files to the project.

Manual

Baby Buddy has support for translation/localization. A manual translation process will look something like this:

1. Set up a development environment (see Development below).

2. Run gulp makemessages -l xx where xx is a specific locale code in the ISO 639-1 format (e.g., "il" for Italian or "es" for Spanish). This creates a new translation file at locale/xx/LC_MESSAGES/django.po, or updates one if it exists.

3. Open the created/updated django.po file and update the header template with license and contact info.

4. Start translating! Each translatable string will have a msgid value with the string in English and a corresponding (empty) msgstr value where a translated string can be filled in.

5. Once all strings have been translated, run gulp compilemessages -l xx to compile an optimized translation file (locale/xx/LC_MESSAGES/django.mo).

6. To expose the new translation as a user setting, add the locale code to the LANGUAGES array in the base settings file (babybuddy/settings/base.py).

7. Check if Plotly offers a translation (in node_modules/plotly.js/dist/) for the language. If it does:

   1. Add the Plotly translation file path to gulpfile.config.js in scriptsConfig.graph.

   2. Build, collect, and commit the /static folder (see gulp updatestatic).

8. Check if Moment offers a translation (in node_modules/moment/locale/) for the language. If it does:

   1. Add the Moment translation file path to gulpfile.config.js in scriptsConfig.vendor.

   2. Build, collect, and commit the /static folder (see gulp updatestatic).

9. Run the development server, log in, and update the user language to test the newly translated strings.

Once the translation is complete, commit the new files and changes to a fork and create a pull request for review.

For more information on the Django translation process, see Django's documentation section: Translation.

Development

Requirements

• Python 3.6+, pip, pipenv
• NVM (NodeJS 14.x and NPM 7.x)
• Gulp
• Possibly libpq-dev
  • This is necessary if psycopg2 can't find an appropriate prebuilt binary.

Installation

1. Install pipenv per Installing pipenv

2. Install required Python packages, including dev packages

   pipenv install --three --dev
   

   • If this fails, install libpq-dev (e.g. sudo apt install libpq-dev) and try again.

3. Installed Node 14.x (if necessary)

    nvm install 14
   

4. Activate Node 14.x

    nvm use
   

5. Install Gulp CLI

   npm install -g gulp-cli
   

6. Install required Node packages

   npm install
   

7. Set, at least, the DJANGO_SETTINGS_MODULE environment variable

   export DJANGO_SETTINGS_MODULE=babybuddy.settings.development
   

   This process will differ based on the host OS. The above example is for Linux-based systems. See Configuration for other settings and methods for defining them.

8. Migrate the database

   gulp migrate
   

9. Create cache table

   gulp createcachetable
   

10. Build assets and run the server

    gulp
    

    This command will also watch for file system changes to rebuild assets and restart the server as needed.

Open http://127.0.0.1:8000 and log in with the default username and password (admin/admin).

Gulp commands

gulpfile.js defines Baby Buddy's Gulp commands.

babybuddy/management/commands defines Baby Buddy's management commands.

• gulp
• gulp build
• gulp clean
• gulp collectstatic
• gulp compilemessages
• gulp coverage
• gulp createcachetable
• gulp docs:build
• gulp docs:deploy
• gulp docs:watch
• gulp extras
• gulp fake
• gulp generatescheme
• gulp lint
• gulp makemessages
• gulp makemigrations
• gulp migrate
• gulp reset
• gulp runserver
• gulp scripts
• gulp styles
• gulp test
• gulp updatestatic

gulp

Executes the build and watch commands and runs Django's development server. This command also accepts the special parameter --ip for setting the server IP address. See gulp runserver for details.

build

Creates all script, style and "extra" assets and places them in the babybuddy/static folder.

docs:build

Builds the documentation site in a local directory (site by default).

docs:deploy

Deploys the documentation site to GitHub Pages.

docs:watch

Runs a local server for the documentation site reloading whenever documentation sites files (in the docs directory) as modified.

clean

Deletes all build folders and the root static folder. Generally this should be run before a gulp build to remove previous build files and the generated static assets.

collectstatic

Executes Django's collectstatic management task. This task relies on files in the babybuddy/static folder, so generally gulp build should be run before this command for production deployments. Gulp also passes along non-overlapping arguments for this command, e.g. --no-input.

Note: a SECRET_KEY value must be set for this command to work.

compilemessages

Executes Django's compilemessages management task. See django-admin compilemessages for more details about other options and functionality of this command.

coverage

Create a test coverage report. See .coveragerc for default settings information.

createcachetable

Executes Django's createcachetable management task. See django-admin createcachetable for more details about other options and functionality of this command.

extras

Copies "extra" files (fonts, images and server root contents) to the build folder.

fake

Adds some fake data to the database. By default, fake creates one child and 31 days of random data. Use the --children and --days flags to change the default values, e.g. gulp fake --children 5 --days 7 to generate five fake children and seven days of data for each.

generateschema

Updates the openapi-schema.yml file in the project root based on current API functionality.

lint

Executes Python and SASS linting for all relevant source files.

makemessages

Executes Django's makemessages management task. See django-admin makemessages for more details about other options and functionality of this command. When working on a single translation, the -l flag is useful to make message for only that language, e.g. gulp makemessages -l fr to make only a French language translation file.

makemigrations

Executes Django's makemigrations management task. Gulp also passes along non-overlapping arguments for this command.

migrate

Executes Django's migrate management task. In addition to migrating the database, this command creates the default admin user. Gulp also passes along non-overlapping arguments for this command.

reset

Resets the database to a default state with one fake child and 31 days of fake data.

runserver

Executes Django's runserver management task. Gulp passes non-overlapping arguments for this command.

A special parameter, --ip, is also available to set the IP for the server. E.g., execute gulp runserver --ip 0.0.0.0:8000 to make the server available to other devices on your local network.

scripts

Builds and combines relevant application scripts. Generally this command does not need to be executed independently - see the build command.

styles

Builds and combines SASS styles in to CSS files. Generally this command does not need to be executed independently - see the build command.

test

Executes Baby Buddy's suite of tests.

Gulp also passes along non-overlapping arguments for this command, however individual tests cannot be run with this command. python manage.py test can be used for individual test execution.

updateglyphs

Downloads generated glyph font files data from Fonttello based on config.json file. This only needs to be run after making changes to the config file.

updatestatic

Rebuilds Baby Buddy's /static folder by running the following commands in order:

• lint
• clean
• build
• collectstatic

Execute and commit changes made by this command whenever changing Baby Buddy's frontend code (SASS, JS, etc.).

Icon Font

Baby Buddy uses Fontello to build a custom icon font for icons used throughout the application. See babybuddy/static_src/fontello for further documentation about using the config file with Fontello and license information for fonts used by this application.