1.2.1 • Published 2 years ago

@faisonslepoint/expi v1.2.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago
   __/\\\\\\\\\\\\\\\___________________________________        
 _\/\\\///////////____________________________________       
  _\/\\\_____________________________/\\\\\\\\\___/\\\_      
   _\/\\\\\\\\\\\______/\\\____/\\\__/\\\/////\\\_\///__     
    _\/\\\///////______\///\\\/\\\/__\/\\\\\\\\\\___/\\\_    
     _\/\\\_______________\///\\\/____\/\\\//////___\/\\\_   
      _\/\\\________________/\\\/\\\___\/\\\_________\/\\\_  
       _\/\\\\\\\\\\\\\\\__/\\\/\///\\\_\/\\\_________\/\\\_ 
        _\///////////////__\///____\///__\///__________\///__

Express API RESTFull Scaffolding (expi)

This is just a Express.js API RESTFull generator, which is can be used as a starting point for any express application.

This project is based on the excellent idea of TrulyMittal But with some additions ;)

Installation šŸ­

$ npm install -g @faisonslepoint/expi

Quick Start šŸƒā€ā™‚ļø

The quickest way to get started is to utilize the executable expi to generate an application as shown below:

Create (and start) the app in current folder:

$ expi .
$ npm run dev

OR, create (and start) the app (in myApp folder):

$ expi myApp
$ cd myApp
$ npm run dev

This will basically create this structure in your folder if you choose 'Simple API'

.
ā”œā”€ā”€ node_modules
ā”œā”€ā”€ .env
ā”œā”€ā”€ package-lock.json
ā”œā”€ā”€ package.json
└── server.js    

This is how easy it is to get going.

If you choose specifics resources

.
└── controllers
    └── ... .js
    └── ... .js
ā”œā”€ā”€ node_modules
ā”œā”€ā”€ routers
|   └── ... .js
|   └── ... .js
ā”œā”€ā”€ .env
ā”œā”€ā”€ package-lock.json
ā”œā”€ā”€ package.json
└── server.js

A picture is worth a thousand words.

What dependencies it installs ?

  • express - express framework
  • dotenv - for env variables
  • cors - for CORS Policy
  • nodemon (dev) - monitors changes in files

YouTube šŸ“ŗ

https://www.youtube.com/@FaisonsLePoint

License šŸŽ«

MIT