Code Monkey home page Code Monkey logo

gmail-contacts-extension-server's Introduction

gmail-extension-server

Gmail Chrome Extension Backend

Set up Configuration

Copy and fill out the env file

cp .env.example .env
# Server PORT
PORT=

# DB Configuration
DB_HOST= // if you are using docker, please set as 'db'
DB_USER=
DB_PASS=
DB_NAME=

Running Server

With Docker

1. Build docker image

docker-compose up --build

2. Running server with detach mode

docker-compose up -d

Without Docker

1. Install npm packages

yarn install or npm install

2. Running with development mode

yarn dev or npm run dev

3. Running with production mode

yarn build or npm run build
yarn start or npm start

Swagger API Docs

http://localhost:${PORT}/docs

Notes

  • Tsoa doesn't like Omit<>. Use Pick<> instead, even if more verbose

gmail-contacts-extension-server's People

Contributors

webexp0528 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.