Skip to content

TarekM-7/tforge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tforge

CLI scaffolding tool that generates Express, Mongoose and EJS project structures from a single terminal command.

Install

Clone the repository and install globally:

git clone https://github.com/TarekM-7/tforge.git
cd tforge
npm install
npm install -g .

Usage

tforge <project-name>

Example

tforge my-app

You will be prompted to choose whether to install dependencies and initialize a Git repository automatically.

What it generates

my-app/
├── views/
│   ├── boilerplate/
│   │   └── boilerplate.ejs
│   └── index.ejs
├── public/
│   ├── css/
│   │   └── styles.css
│   └── js/
│       └── app.js
├── models/
├── routes/
├── seeds/
├── utils/
├── .gitignore
├── index.js
└── package.json

The generated project comes with:

  • Express server wired up and ready to run
  • Mongoose connected to a local MongoDB database named after your project
  • EJS with ejsMate for layout support
  • method-override for PUT and DELETE requests
  • A base boilerplate layout in views/boilerplate/
  • Static files served from public/
  • A starter route at /
  • A 404 catch-all handler

Options

tforge --help       Display help information
tforge -h           Display help information

Running the generated project

cd my-app
npm start

Make sure MongoDB is running locally before starting the server.

Built with

About

CLI scaffolding tool that generates Express, Mongoose and EJS project structures from the terminal. Built with Node.js.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors