Skip to content

Latest commit

 

History

History
161 lines (138 loc) · 4.37 KB

README.md

File metadata and controls

161 lines (138 loc) · 4.37 KB
Raw

CURATOR

Curator is an html builder using the template engine edge from Adonis, we try to implement the template engine from the backend to the frontend, this template engine is very similar to the blade of Laravel. Curator has also used Laravelmix for its bundler assets and already, includes bootstrap version 4 and other supporting components

Installation

  1. You need Nodejs and latest version npm https://nodejs.org/en/
  2. Run npm install --save-dev
  3. Setup .env file for setting configuration
  4. Run Npm start for starting dev server and compile html , and npm run watch for compile assets
  5. Happy coding

Features:

  1. Dev Server (inludes host and port)
    • You can set route host and port in .env file at root folder
  2. Dotenv
  3. Configure with Laravelmix https://laravel-mix.com/
  4. Template engine ( use edge ) https://edge.adonisjs.com/
  5. Compile to html file
  6. Data Parse
  7. Beauty Routing (Manual And Automatic)
  8. Autoload
  9. Pretify html

Setup .ENV

No CODE Type Function Example
1 APP_NAME String Set global applicaton name Curator
2 APP_MODE String Set Application mode development , deploy
3 HOST String Set Application dev server host 0.0.0.0
4 PORT Integer Set Application dev server port 9090 , 8080 , 80
5 COMPILE_DIR String Set Compile edge file directory resources/views
6 PUBLIC_DIR String Set Compiles html file directory 9090 , 8080 , 80
7 COMPILE Boolean Set compile mode true , false
8 ROUTER String Set Router Type manual (you need define route in router file) , auto
9 PRETIFY_HTML Boolean Pretifying Html file after compile true , false
10 AUTOLOAD Boolean Set autolaod for dev server true , false

Creating Manual Route

Route file in app/route.json you can define your file and route name at this but you need set router in .env file to manual

Disable Compile Directory

This have function for disabling compile and acces directory at compile process You can set in app/protector.json

Creating And Access Data

Data file in app/data you need to define your json file in register.json for access data in your webpage (example was includes)

Creating Api For Dev server

Before use api you need to register route api in app/api.json after that in app/api/* you can create new api file (ex : user.json) (example was includes )

Replacing String On File

This have function to replace string in file in compile process You can set on app/helpers/helpers.json Parameter :

  1. compile : Process after compile or before compile
  2. mode : Application mode in .env file
  3. subdir : file directory , this will be very useful if you use multiple languages
  4. find : words you want to find
  5. replace : sentence or word that will replace it

Helpers Function

This Have function to manualy creatiing global function and you can access this on odge file You can set helper function in app/helpers/helpers.js

Note

  1. Dont Modify bin directory

Components

  1. https://edge.adonisjs.com/
  2. https://laravel-mix.com/
  3. https://jquery.com/
  4. https://www.npmjs.com/package/live-server
  5. https://github.com/axios/axios
  6. https://getbootstrap.com/

Demo

  1. https://curator-test.herokuapp.com/