Update README for Database Configuration and Migration Scripts - Githubissues

sef-global / scholarx-backend

This is the backend of the ScholarX

MIT License

11 stars 41 forks source link

Update README for Database Configuration and Migration Scripts #144

Closed ItsLasa closed 4 months ago

ItsLasa commented 4 months ago

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

[x] This PR doesn't commit any keys, passwords, tokens, usernames, or other secrets.
[x] I have read and understood the development best practices guidelines ( http://bit.ly/sef-best-practices )
[x] 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
[x] I have made corresponding changes to the documentation

Related PRs

## Test environment ## Learning