Giter VIP home page Giter VIP logo

qtpd-api's Introduction

¿Qué tenés para dar? - API

Introduction

This is a RESTful API to show where the users can bring their donations based on what they have to donate and where they are. By using this API you can handle users with roles, centers and donation types.

Installation

  • To install the API run:
    npm install
    

Environment configurations

In order to run the app. You need to provide the following variables for the project:

  • API:
    • PORT - the port where the api will run
    • MONGODB_URL - the url where the mongo database lives and its name. (e.g.: =mongodb://127.0.0.1:27017/qtpd-db)
    • JWT_SECRET - Json web token secret key
    • The following data is needed to send emails from a gmail account:
      • EMAIL_USER
      • GMAIL_CLIENT_ID
      • GMAIL_CLIENT_SECRET
      • GMAIL_REFRESH_TOKEN Note: For development purposes, I would recommend to provide those variables in a file 'dev.env' under a 'config' folder in the root folder of the api project

Usage

  • To start the API run:
    npm start
    

Development

  • To run the API in development mode:
    npm run dev
    

Docker

A Dockerfile is provided in order to create your own image. Note that you will need to provide the environment variables for the docker image.

Authors

Martin Manzo & Alvaro Farina

qtpd-api's People

Contributors

dependabot[bot] avatar itofarina avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.