README.md

Hackathon Submission - here

Yearn Quest

Let's end the Hunger ✊


View Demo · Report Bug

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. License
4. Contact

About The Project

(back to top)

Built With

• Bootstrap
• JQuery
• Ejs
• NodeJs
• Sawo API
• Twilio sendgrid

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

• You need Sawo and Twilio SendGrid API keys for this project.

Installation and Setup

1. Clone the repo

   git clone https://github.com/RakeshPotnuru/YearnQuest.git

2. Install NPM packages

   npm install

3. Create nodemon.json file in the /root directory

   {
      "env": {
        "DB_URL": "mongodb://localhost:27017/databaseName"
        "SENDGRID_API_KEY" : "Sendgrid API key"
        "SENDER_EMAIL": "Sender email"
       }
    }
   

4. Create a config.js file at public/js/ and add Sawo api key

const keys = {
  SAWO_API_KEY: "Sawo api key",
};

4. To start the server

   npm run dev
   

(back to top)

License

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

(back to top)

Contact

• Rakesh - @RakeshPotnuru
• Rwitesh Bera - @rwiteshbera
• Aqsa Shadab Khan - @aqsak1

Project Link: YearnQuest

(back to top)