Git Product home page Git Product logo

kickstart's Introduction

KickStart is a boiler plate for Enterprise Web Applications. It is primarily a front-end solution and can be used with back-end written in any language. The project includes few server side solutions located in "/api" folder. All front-end related source files are in "/web" folder.

Installation

Before using project tools, you need to install NPM and NodeJS. To install dependencies run:

npm install --production             // for production
npm install                          // for development

To run development tasks configured in gulpfile.js run:

gulp dev

This will auto compile all your LESS files as well as generated icon-font

JSON Back-End

Since data is read from static JSON files and cannot be modified, JSON back-end is purely for demo purposes. It is enabled by default. You can change it in "/web/app/home/config.js" file by modifying "context" property. If you use Nginx as web server and you have problem with POST request - 405 Not Allowed , there is small hack: http://stackoverflow.com/questions/24415376/post-request-not-allowed-405-not-allowed-nginx-even-with-headers-included

#nginx.conf
server {
		listen       80;
		...
		error_page  403     /403.html;
		# To allow POST on static pages
		error_page  405     =200 $uri;
		...
}

NodeJS Back-End

To use NodeJS back-end you need to do a series of steps:

  • Install and start MongoDB server (used for session storage)
  • Install and start PostgreSQL DB server
  • Run SQL scripts in "/setup" folder
  • Change DB configuration in "/api/node/conf.js" file
  • Change "context" property to 'http://localhost:3000'

To run NodeJS locally

nodemon api/node/start.js

To start MongoDB (used for sessions)

mongod --dbpath /Users/vitali/Library/MongoDbData &

Folder Structure

/api					- Server side code
	/json				- sample JSON back-end
	/node				- sample NodeJS back-end
		/admin				- admin module
		/shared				- shared components
		/mod-1				- module 1
		/mod-N				- module N
		/w2ui				- server side w2ui library
		/conf.js			- DB and other config
		/security.js		- security file
		/start.js			- server side STARTING POINT
/build					- Build folder
/log					- Logs
/node_modules			- NodeJS modules
/setup					- DB setup scripts
/web					- Front-End Code
	/app					- Application
		/mod-1				- module 1
		/mod-N				- module N
		/icons				- icon font icons
		/modules.js			- description of all modules
		/start.js			- client side STARTING POINT
	/libs					- 3rd party libraries
	index.html 				- index page
	login.html 				- login page
Gruntfile.js			- build tool config
package.json			- npm dependencies
README.md				- this read me file

kickstart's People

Contributors

vitmalina avatar mrg2001 avatar dubo avatar

Watchers

James Cloos avatar Oscar Rafael 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.