Dr Green Backend

Here lies the backend for project Dr Green

View Demo · Report Bug

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact

About The Project

Dr Green

Getting Started

Please follow the instructions to run the service on you local machine / setup on a server

Prerequisites

Required system dependencies:

• Node version >= 18.16.0
• Npm version >= 8.6.0
• Operation Systems - Window / Linux

Installation

1. Clone the repository and change the directory to the root of the source code.

   git clone https://github.com/DrGreenNft/dr-green-backend.git

2. Install NPM packages.

   npm install

3. Set your API Keys in .env file.

   // STAGING
    DATABASE_URL = ""
    DEV_PORT = 3000
    DEV_JWT_SECRET_LOGIN = ""
    DEV_JWT_SECRET_VERIFY_EMAIL = ""
    DEV_JWT_SECRET_2FA = ""
    DEV_NFT_CONTRACT_ID = ''
    DEV_NFT_MARKETPLACE_CONTRACT_NAME = ""
    DEV_NFT_MARKETPLACE_CONTRACT_ID = ''
    DEV_CONTRACT_DEPLOYED_CHAIN_ID = 11155111
    DEV_RPC_PROVIDER_URL = ""
   
    #AWS Credentials
    DEV_AWS_BUCKET_NAME = 'app-profile'
    DEV_AWS_ACCESS_KEY_ID = 'FDFGHJKJtyhgf757cVB'
    DEV_AWS_SECRET_ACCESS_KEY = 'Vdstgyf7yeh8uwhdbUHGFJs549jsyHhe4341X'
    DEV_AWS_REGION='ap-south-1'
    DEV_SENDGRID_API_KEY = 'SG.6f5tujnhvGFYGBGRuytrfvcXDFGHNjuytgvcfgbhDTYu76ibvfh'
    DEV_ADMIN_EMAIL = "xyz.admin@gmail.com"
    DEV_FRONTEND_URL = 'https://marketplace.drgreennft.com'

Technologies Used

• NestJs
• TypeScript
• AWS
• SendGrid
• PostgresSql

Project Status

In Progress

Usage

To start the service, run the following command as per needed:

In the project directory, you can run:

npm run start:dev

Runs the app in the development mode.
Open [http://localhost:3000/api/v1/public/healthStatus] to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

(back to top)