1.0.0 • Published 3 years ago

xanda v1.0.0

Weekly downloads
1
License
MIT
Repository
-
Last release
3 years ago

NPM Commands

  • Develop: npm run dev
  • Compile CSS: npm run build:css
  • Build JS: npm run build:webpack
  • Build production: npm run build

Build process

  • It will create a build folder with all the necessary files
  • Copy the content of build folder to the public folder on the server

File structure

  • /app/js/server.js - Creating the local server when running npm run dev
  • /app/js/client.js - Index.js file, sets up the routes and requires the necessary files
  • /app/js/common/actions - Redux actions
  • /app/js/common/components - Custom made, reusuable modules
  • /app/js/common/containers - Each route has a subfolder within its action files (Add, Edit, List, View)
  • /app/js/common/reducers - Saves each api group type to the global store
  • /app/js/common/store - Creates the global store
  • /app/js/common/utils - Global, reusuable functions for api calls, validation, socket, etc.

Building the project for local development

  • First, you need to log into the npm using the Xanda credentials running this command, npm login
  • After you have logged in, you need to install the node modules running this command, npm install/ npm i
  • Then you need to running this command when you are launching the project for the first time, npm run build-dev
  • After that, you need to run npm run dev command and can access the site on localhost:8080