KO
|
EN
gitlite — search
Search
#python
#java
#php
#javascript
#kubernetes
#deep-learning
#machine-learning
#docker
#r
#mqtt
#react
#c
feastjs
★ 21
Open GitHub ↗
MVC framework generator
Download README (.md)
Explore Similar Repositories
FEAST
:
A FEAture Selection Toolbox for C/C+, Java, and Matlab/Octave.
feastruct
:
A python package for structural finite element analysis.
feast_trino_NE
:
No description available.
FeaStNet
:
Pytorch reproduction of the paper "FeaStNet: Feature-Steered Graph Convolutions for 3D Shape Analysis" (CVPR 18)
awesome-mlops
:
Production-grade MLOps: Model deployment, monitoring, feature stores, and ML pipelines for real-world AI systems.
// repository documentation
Was this content helpful?
★ 0
(0 ratings)
Select Rating:
★
★
★
★
★
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
feastjs
?
Download (.md)
# FeastJS [](https://travis-ci.org/agrim123/feastjs) [](https://npmjs.org/package/feastjs) [](https://npmjs.org/package/feastjs) FeastJS is a CLI tool to standardize the directory structure for Node apps. The file structure reflects that of rails. ## Motivation Recently while I was working on a few Node apps, I had to manually create a directory structure and place files accordingly. So, I came up with the idea of creating a CLI tool that does just that for me. This is still in dev phase and needs some modifications and additions. ## Installation ```sh $ [sudo] npm install -g feastjs ``` ## Quick Start The quickest way to get started with feastjs is to utilize the executable `feast` to generate an application as shown below: Create the app: ```bash $ feast new myapp create : myapp create : myapp/package.json create : myapp/.env create : myapp/app.js create : myapp/gulpfile.js create : myapp/app create : myapp/db create : myapp/db/setup.js create : myapp/db/seed.js create : myapp/public create : myapp/public/js create : myapp/public/images create : myapp/public/css create : myapp/routes create : myapp/routes/routes.js create : myapp/bin create : myapp/bin/www create : myapp/app/assets create : myapp/app/controllers create : myapp/app/controllers/index_controller.js create : myapp/app/models create : myapp/app/helpers create : myapp/app/views create : myapp/app/middlewares create : myapp/db/migrations create : myapp/test/controllers create : myapp/test/helpers create : myapp/test/models create : myapp/app/assets/javascripts create : myapp/app/assets/javascripts/script.js create : myapp/app/assets/stylesheets create : myapp/app/assets/stylesheets/style.css create : myapp/app/views/index create : myapp/app/views/index/home.ejs create : myapp/app/views/error.ejs create : myapp/app/views/partials create : myapp/app/views/partials/head.ejs create : myapp/app/views/partials/footer.ejs create : myapp/test create : myapp/test/controllers/index_controller_test.js install dependencies: $ cd myapp && npm install run the app: $ DEBUG=myapp:* npm run watch ``` Install dependencies: ```bash $ npm install ``` OR use [yarn](https://yarnpkg.com/en/) ```bash $ yarn install ``` Setup your assets: ```bash $ gulp ``` Currently it supports only `PostgreSQL` Update `.env` file Run ``` $ npm run db:setup ``` Start your app at `http://localhost:3000/`: ```bash $ npm start ``` To watch over file changes (hugely reduces pain of restarting server) : ```bash $ npm run watch ``` ## File Structure ```bash myapp | |____app | | | |____assets | | |____javascripts | | |____stylesheets | | | |____controllers | | |____index_controller.js | | | |____models | | | |____helpers | | | |____middlewares | | | |____views | |____index | | |____home.ejs | | | |____partials | | |____footer.ejs | | |____header.ejs | | | |____error.ejs | |____db | |___seed.js | |___setup.js | | | |___migrations | |____test | |___controllers | | | |___models | | | |___helpers | |_____routes | |___routes.js | |____public | |____css | | | |____js | | | |____img | |_____app.js | |_____gulpfile.js | |_____package.json | |____node_modules ``` ## Command Line Options This generator can also be further configured with the following command line flags. ```bash Usage: feast [options] [command] Commands: help [command] new|n <name> generate|g <typeGenerate> <name> [listToBeGenerated...] delete|d <typeDelete> <name> * Options: -h, --help output usage information -v, --version output the version number --git add gitignore ``` ### Generate Controllers ```bash $ feast generate controller static_pages index home create : /home/hitman/myapp/app/controllers/static_pages_controller.js route : get 'static_pages/home' route : get 'static_pages/index' invoke test_unit create : /home/hitman/myapp/test/controllers/static_pages_controller_test.js invoke helper create : /home/hitman/myapp/app/helpers/static_pages_helper.js invoke js create : /home/hitman/myapp/app/assets/javascripts/static_pages.js invoke css create : /home/hitman/myapp/app/assets/stylesheets/static_pages.css invoke ejs create : /home/hitman/myapp/app/views/static_pages create : /home/hitman/myapp/app/views/static_pages/home.ejs create : /home/hitman/myapp/app/views/static_pages/index.ejs ``` Navigate to `/static_pages/index` ### Generate Models ```bash $ feast generate model random title:string plate:number create : myapp/app/models/random.js create : myapp/test/models/random_test.js create : myapp/db/migrations/[timestamp]_create_random.js ``` Run migrations (this feature is still under dev) ```bash $ npm run migrations ``` ### To-Do - [ ] To add sample login and signup functionality - [ ] Add support for more css engines less|stylus|compass|sass - [ ] Add support for more templating engines - [ ] Add tests ## License [MIT](LICENSE) [downloads-url]: https://npmjs.org/package/feastjs
