Git Product home page Git Product logo

phone-book-challenge's Introduction

Introduction

This project implements a simple REST API that manages contacts and associated phone numbers. It uses objection/knex to manage models and their mapping to the database (postgresql). HTTP server based on Koa, a lightweight and async-friendly alternative to express.

Requirements

Installation

Run npm i to install dependencies.

Configuration

This app takes a "configuration through JS" approach which can give more flexibility compared to regular JSON files. Config files are stored under config with "{environment}.js" naming pattern.

You can use ENV environment variable to specify the desired environment. Default one is "development".

Create database

Create an empty postgresql database and make sure its name and associated user credentials are matching to corresponding values in the config file.

Run npm run db_migrate to populate database structure.

Optionally you can specify an environment: npm run db_migrate -- --env production

Note: To roll back the last migration you can use npm run db_rollback

Note: For more complex cases you may need to install knex CLI globally (along with postgresql driver) or directly invoke local version like this: ./node_modules/.bin/knex ...

Run specs

Note: Make sure you created a development database.

Run npm test

Run API server

Note: Make sure you created a production database.

Run npm start

phone-book-challenge's People

Contributors

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