sef-global / scholarx-backend

This is the backend of the ScholarX
MIT License
11 stars 39 forks source link

Update README for Database Configuration and Migration Scripts #143

Closed mayura-andrew closed 3 months ago

mayura-andrew commented 3 months ago

Description: We need to update the current README file to include instructions for the following database migration and seeding commands:

This update is necessary to guide new contributors on how to configure the database correctly and understand the migration process.

Tasks:

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

Acceptance Criteria:

Additional Information:

Related Dependencies or References:


ItsLasa commented 3 months ago

hey @mayura-andrew i would like to work on this issue.

mayura-andrew commented 3 months ago

@ItsLasa Nice go ahead 🚀