Skip to content

mahanfr/ZilloJs

Repository files navigation

Contributors Forks GitHub language count GitHub followers GitHub



Structure based web framework

Structure-Base backend web framework inspired by django and express. project is under development and not ready for production but you can contribute to it

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contacts

About Project

Re-inventing the wheel basically! but it's started because i loved django framework but not python so much. I always wanted to be a framework like django for another programming language that has static typing and can compile so... JavaScript. no I choose js because it was easier and i don't hate myself. there are plans to rewrite this framework in a better language but thats for future.I love to work on this project and complete it even more. if you are interested you can contribute too.

Getting Started

This project currently is in beta state and it is NOT STABLE FOR PRODUCTION but you can still use in development and for small html projects that want to make advantage of it's template engine

Requirements

This project is using ES6 javaScript imports so you need node js 14 or higher to run this project without any errors

  • Node js > v14.18.0
  • npm > 8.0.0

Installation

As of beta version you need to set up your package.json in a way that makes you use .js file imports in your project. create a folder inside your directory and initialize npm:

mkdir myProject
cd ./myProject
npm init -y

after running this commands npm adds a package.json file inside your project directory. add this line a the bottom of the file before closing cully bracket

"type":"module"

For downloading and installing zillo.js you have to use npm by writing the command bellow inside your favorite command line:

npm i zillojs

Roadmap

We have big plans for this project. But reality is what we care about.The roadMap bellow

  • Host single a page
  • Routing
  • Reading Queries
  • Attaching views
  • Html views and custom template Engine
  • connecting to a db
  • orm and models
  • helpers and api calls
  • Setting and file Management
  • Class and Function views

License

Every line of code written is under MIT Licence


Contacts

Mahan Farzaneh - @mahan_farzaneh - mahan.farzaneh@gmail.com

LinkedIn Twitter URL Twitter Follow