README.md

Quicky Admin Main Backend

This repository includes the project files related to admin main backend of Quicky delivery platform.

Getting Started

To get started with the project, follow these steps:

1. Clone the repository:

   git clone https://github.com/HashiruG/Quicky_Backend.git

2. Navigate to the project directory:

   cd Quicky_Backend

3. Create application.properties files in the src/main/resources/application.propertie as follows

   #DATABASE CONFIGURATIONS
   
   spring.datasource.url=jdbc:postgresql://<YOUR_DATABASE_HOST>:<PORT>/<YOUR_DATABASE_NAME>
   spring.datasource.username=<YOUR_DATABASE_USERNAME>
   spring.datasource.password=<YOUR_DATABASE_PASSWORD>
   
   #EMAIL CONFIGURATIONS
   
   spring.mail.host=smtp.gmail.com
   spring.mail.port=587
   spring.mail.username=<YOUR_GMAIL_ADDRESS>
   spring.mail.password=<YOUR_GMAIL_APP_PASSWORD>
   spring.mail.properties.mail.smtp.auth=true
   spring.mail.properties.mail.smtp.starttls.enable=true
   
   #JWT CONFIGURATIONS
   
   jwt.secret=<YOUR_JWT_SECRET>
   
   #STRIPE CONFIGURATIONS
   
   stripe.api.key=<YOUR_STRIPE_API_KEY>
   
   #CHURN PREDICTION SERVICE URL
   
   churn.predict.backend.url=http://churnprediction-bpabevemamakegad.southindia-01.azurewebsites.net/predict_batch

4. Build the project:

   mvn clean install

5. To start the server:

   mvn spring-boot:run

Other Repositories associated with this project

1. Quicky admin frontend : https://github.com/HashiruG/Quicky_Frontend
2. Quicky admin churn prediction : https://github.com/HashiruG/Quicky_Admin_Churn_Prediction

Few Screenshots