Code Monkey home page Code Monkey logo

jsberry's Introduction

JSBerry Logo
JSBerry

contributions welcome GitHub last commit HitCount GitHub issues GitHub pull requests GitHub release license

JSBerry is open source modular simple architecture for building Node.js applications.

JSBerry is not a framework. It's a solution for creating applications using any frameworks, modules and plugins.

Documentation

Modules and plugins store

How to core work

Quick start

git clone https://github.com/Dugnist/jsberry project
cd project
npm i

If you wanna use express as default framework - you need to run this script to install "express" dependencies:

npm run install-express

And finally - start your application:

npm start

If you wanna install another framework instead of "express" - you can check Modules and plugins store.

Also you can check src/core/config/index.js to set key "framework" to your framework name (default "express").

List Of Scripts

  • npm start - run application with development mode
  • npm run prod - run application with production mode
  • npm run inspect - run application with node debugger (dev mode)
  • npm run check - run npm modules vulnerabilities checker (npm i nsp -g)
  • npm run protect- run npm modules vulnerabilities checker (npm i snyk -g)
  • npm run install-express- install all dependencies for default express module

Docker

Check default Dockerfile for the line RUN npm run install-express if you use another framework instead "express".

To build simple Docker jsberry image:

  sudo docker build -t `$user`/jsberry .

To run build:

  sudo docker run -p 8080:8000 -d `$user`/jsberry

To restart container automatically:

  sudo docker run -dit --restart unless-stopped `$user`/jsberry

To remove unused (:) images use:

  sudo docker rmi $(sudo docker images -f "dangling=true" -q)

Debugger

Run npm run inspect and open this url in browser:

chrome-devtools://devtools/bundled/inspector.html?experiments=true&v8only=true&ws=127.0.0.1:9229/${uuid}

where "uuid" - debug session id from console.

OR:

Install extension nodejs-v8-inspector and launch it on 9229 port.

What's new?

You can check our ROADMAP and propose new features.

Community support

For general help using JSBerry, please refer to the official documentation. For additional help, you can use ask question here:

Author

Dugnist Alexey

Copyright and license

Code and documentation copyright 2017-2018 JSBerry. Code released under the MIT license.

jsberry's People

Contributors

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