Giter Site home page Giter Site logo

node-rest-api's Introduction

node-rest-api

node.js REST API scaffold to create dummy endpoints on localhost.

Requirements

  • local mysql database
  • node package installed on your machine

Setup

  • run mysql -u {username} -p {database_name} < db_schema.sql to import the db schema
  • create .env file in root directory of this project
  • add environment variables for your mysql configuration, see example syntax below
  • add your new endpoints under /routes/{your_endpoint}.js
  • add your routing to app.js
  • run npm start
  • curl localhost:3000/{your_endpoint}

.env file syntax

DB_HOST=localhost
DB_USER=root
DB_PASS=pass
DB_NAME=database_name

API_SECRET=helterskelter  

node-rest-api's People

Contributors

nerdsrob avatar

Watchers

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