Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README for Database Configuration and Migration Scripts #144

Merged
merged 1 commit into from
Jul 31, 2024

Conversation

ItsLasa
Copy link
Contributor

@ItsLasa ItsLasa commented Jul 30, 2024

Purpose

The purpose of this PR is to fix #143. This update is necessary to guide new contributors on how to configure the database correctly and understand the migration process.

Goals

  • Add a section in the README for database configuration.
  • Include details on how to set up the database.
  • Provide example configuration settings.
  • Add a section for migration commands.
  • Explain the purpose of each command (migration, migration, sync, seed).
  • Provide usage examples for each command.
  • Update the existing content for clarity and coherence with the new sections.

Approach

  • Updated the README to include comprehensive instructions on database setup and configuration.
  • Added specific sections for database migration and seeding commands.
  • Provided examples and explanations for each command to ensure clarity.

Screenshots

Checklist

  • This PR doesn't commit any keys, passwords, tokens, usernames, or other secrets.
  • I have read and understood the development best practices guidelines ( http://bit.ly/sef-best-practices )
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation

Related PRs

Test environment

Learning

Copy link
Member

@anjula-sack anjula-sack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! @ItsLasa

@anjula-sack anjula-sack merged commit c1092f4 into sef-global:main Jul 31, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README for Database Configuration and Migration Scripts
2 participants