Skip to content

Latest commit

 

History

History
119 lines (77 loc) · 4.59 KB

docs.md

File metadata and controls

119 lines (77 loc) · 4.59 KB

Setting up and Configuring VSMSAlert

To set up and configure VSMSAlert, please follow the instructions below:

Prerequisites

Installation Steps

  1. Clone the repository:

    git clone https://github.com/kwabenasapong/VSMSAlert.git

  2. Navigate to the project directory:

    cd VALCOSMSAlertSystem

  3. Install the project dependencies:

    dotnet restore

  4. Update the database connection string:

    • Open the appsettings.json file.

    • Locate the ConnectionStrings section.

    • Replace the placeholder values with your database connection details.

      "ConnectionStrings": {
  "DefaultConnection": "Server=your-server-name;Database=your-database-name;User=your-username;Password=your-password;"
}

  5. Apply the database migrations:

    dotnet ef database update

    This will create the necessary tables in the database.

  6. Update the Hubtel API credentials:

    • Open the appsettings.json file.

    • Locate the HubtelSettings section.

    • Replace the placeholder values with your Hubtel API credentials.

      "HubtelSettings": {
  "ApiKey": "your-api-key",
  "ClientId": "your-client-id",
  "ClientSecret": "your-client-secret"
}

  7. Run the application:

    dotnet run

    The application will start running on https://localhost:7071 by default.

  8. Access the application:

    Open your web browser and navigate to https://localhost:7071 to access the VSMSAlert application.

Configuration

Additional configuration options can be found in the appsettings.json file. You can modify these settings based on your requirements. Some of the key configuration options include:

  • Logging: Configure logging options such as log levels and output destinations.
  • EmailSettings: Configure email server settings for email notifications.
  • TwilioSettings: If you want to use Twilio instead of Hubtel for SMS messaging, provide your Twilio API credentials.
  • AdminSettings: Configure the admin account details, such as the admin username and password.

Troubleshooting

If you encounter any issues during the setup or usage of VSMSAlert, you can refer to the following troubleshooting steps to help resolve common problems:

1. Database Connection Issues

  • Double-check the database connection string in the appsettings.json file to ensure it is correctly configured with the appropriate server name, database name, username, and password.
  • Verify that the database server is running and accessible from your machine.
  • Ensure that the specified database and user have the necessary permissions to create and modify tables.

2. API Credential Issues

  • If you are facing issues with the Hubtel Quick SMS API integration, verify that you have entered the correct API key, client ID, and client secret in the appsettings.json file.
  • Ensure that your Hubtel API credentials are valid and have the necessary permissions to send SMS messages.

3. Missing Dependencies

  • Ensure that you have installed the required .NET Core SDK version specified in the project's documentation.
  • If you encounter any dependency-related errors during the dotnet restore command, verify your internet connectivity and try running the command again.

4. General Issues

  • Check the application logs for any error messages or exceptions that may indicate the cause of the problem. The logs can be found in the Logs directory or based on your configured logging settings.
  • Consult the project's documentation for any specific troubleshooting steps or known issues related to your problem.
  • If the issue persists, consider reaching out to the project maintainers or the developer community for further assistance.

If none of the troubleshooting steps resolve your issue, please provide detailed information about the problem and any error messages encountered. This will help in diagnosing and resolving the problem effectively.

Documentation

For more detailed instructions on setting up, configuring, and using VSMSAlert, please refer to the documentation.

If you encounter any issues during the setup process or have any questions, please feel free to reach out to us or consult the documentation for troubleshooting steps.