Giter Club home page Giter Club logo

starter-node-express-postgresql's Introduction

Starter code: Node.js, Express, & PostgreSQL

This starter code is intended to be run for the Node.js, Express, & PostgreSQL module in the Thinkful curriculum.

Existing files

As you work through the Node.js, Express & PostgreSQL module, you will be writing code that allows your controllers to connect to and query your PostgreSQL database via Knex. The table below describes the files and folders in the starter code:

Folder/file path Description
src/app.js Directs requests to the appropriate routers.
src/server.js Starts the server on localhost:5000 by default.
src/products/ A folder that contains the products.controller.js and products.router.js files for the products resource.
src/categories/ A folder that contains the categories.controller.js and categories.router.js files for the categories resource.
src/suppliers/ A folder that contains the suppliers.controller.js and suppliers.router.js files for the suppliers resource.
src/db/ A folder where you will add migration and seed files for your database later on.
src/db/fixtures A folder containing sample data you will seed your database with later on.
src/errors/methodNotAllowed.js An error handler for forbidden request methods
.env.sample A sample environment configuration file

In the *.controller.js files, the route handlers return hard-coded data for now, but later on, you will modify the controllers to manipulate and return data from a PostgreSQL database.

This starter code closely follows the best practices and patterns established in the Robust Server Structure module.

Database setup

  1. Set up a new ElephantSQL database instance by following the instructions in the "PostgreSQL: Creating & Deleting Databases" checkpoint.
  2. After setting up your database instance, connect DBeaver to your new database instance by following the instructions in the "PostgreSQL: Installing DBeaver" checkpoint.

Installation

  1. Fork and clone this repository.
  2. Run cp .env.sample .env.
  3. Update your .env file with a connection URL to your ElephantSQL database instance.
  4. Run npm install to install project dependencies.
  5. Run npm run start:dev to start your server in development mode.
  6. In your browser or Postman, navigate to localhost:5000/products. If your server is running properly, you should get back the following json response:
{
  "data": [
    {
      "product_title": "product 1"
    },
    {
      "product_title": "product 2"
    }
  ]
}

If you have trouble getting the server to run, reach out for assistance.

starter-node-express-postgresql's People

Contributors

dalelotts avatar kchia 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.