Giter Site home page Giter Site logo

phone-book-api's Introduction

Phone Book API

Configure app

  1. Create configs folder in the root of the project

  2. Add 2 files in the folder, dev.env and test.env

  3. In each file add the enviroment variables

    ENV=test or dev API_URL=url to api WEB_URL=url to web app DB_URI=uri to connect to database CONN_KEY=secret key for jwt CONN_ALGORITHM=algorithm for jwt PORT=port where the application will run MAILER_SERVICE=service to send emails, should be gmail MAILER_USER=mail address MAILER_PASS=mail password MAILER_CLIENT_ID=variable provided by google MAILER_SECRET=variable provided by google MAILER_REFRESH_TOKEN=variable provided by google MAILER_ACCESS_TOKEN=variable provided by google

  4. To get the variables to configure the mailer function follow this guide

  5. Run dev:sync and test:sync scripts to create the model tables in db

Running the project

$ npm start

Simple build for production

$ npm build

Sync models and database

$ npm run dev:sync
$ npm run test:sync

phone-book-api's People

Contributors

danielcarrizalesnagarro avatar

Watchers

James Cloos avatar Daniel Alejandro Carrizales Juárez 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.