Skip to content

sanishmaharjan/react-app-scaffold

Repository files navigation

React-App-Scaffold framework

React node app scaffold framework.

Folder & main files Structure

  • back-end (back end server side code)
    • baseComponents (framework base components)
      • apiController.js
      • auth.js
      • controller.js
      • controllerBaseTest.js
      • httpError.js
      • logger.js
      • main.js
      • model.js
      • requestDataHandler.js
      • response.js
      • serviceBaseTest.js
    • config (framework configurations)
      • config.js
      • constants.js
    • controllers
    • migrations (Db migration files)
    • models
    • services
    • tests (back end tests)
      • db
      • testDatas
        • seeders (test data seeders)
        • dbCleanUp.js (clean up script that run before every test)
      • testFiles
    • utilities
  • front-end (Front end react code)
    • components (React components)
    • utilities
    • webApp (root static directory)
      • build
      • css
      • error
      • js
  • server (Node server script)
    • process
      • development.js (development env server config)
      • production.js (production env server config)
    • server.js
  • .env.temp (.env reference)
  • .jest.js
  • .prettierrc.js (code formatter config)
  • .sequelizerc (Db configurations)
  • package.json
  • webpack.config.js

Commands:

Dev server start

# Start dev server
yarn server:start:dev 

# Start production server
yarn server:start:production

Stop server

yarn server:stop

View server log

yarn server:log

View server monitor

yarn server:monitor

Create new migration

yarn migrate:create [migration-name]

Run migration

yarn migrate:up

Rollback migration

yarn migrate:down

Test data seed

yarn test:seed:generate [name]

Run backend tests

yarn test:backEnd

Run frontend test

yarn test:frontEnd

Webpack frontend

yarn webpack

Build frontend

yarn build

More Reference

Links