Giter VIP home page Giter VIP logo

express-articles-app's Introduction

Example of RESTful API with Express and Bookshelf.js

Requirements

  • Node.js >=14.13.0
  • NPM >=6.14.8
  • MySQL

Deployment

  1. Clone the application from the repository.

  2. Install dependencies:

     npm ci
    
  3. Create the config.js and knexfile.js files by copying the config.js.example and knexfile.js.example files, respectively:

     cp config.js.example config.js
     cp knexfile.js.example knexfile.js
    
  4. Specify the port and JWT key in the config.js file, and also specify database connection settings for development, production, and test modes in the knexfile.js file.

  5. Create database:

     sudo mysql -uuser -ppass
     > CREATE DATABASE `exress-articles-app` CHARACTER SET utf8 COLLATE utf8_general_ci;
     > exit
    

    Replace user and pass with your username and password, respectively.

  6. Run migrations and seeds:

     npm run migrate
     npm run db:seed
    

The next steps will be different for development and production modes.

Development mode

  1. Install nodemon globally:

     sudo npm i -g nodemon
    
  2. Launch the application:

     npm run start:dev
    

Production mode

  1. Install pm2 globally:

     sudo npm i -g pm2
    
  2. Launch the application:

     npm run start:prod
    

Testing

  1. Create database:

     sudo mysql -uuser -ppass
     > CREATE DATABASE `exress-articles-app_test` CHARACTER SET utf8 COLLATE utf8_general_ci;
     > exit
    

    Replace user and pass with your username and password, respectively.

  2. Run tests:

     npm run test:e2e
    

express-articles-app's People

Contributors

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