sipas v0.0.7
s'ipas your CLI template "store" (framework in the future) for Node.js api's
s'ipas is a CLI for for creating easy api's in nodejs with templates, in the future with your help we hope it will be a framework. Just below you will see the folder structure off sipa.
sipa
┣ bin
┃ ┣ cli.js
┃ ┗ log.js
┣ template
┃ ┗ express.js
┣ .gitignore
┣ .npmignore
┣ LICENSE
┣ README.md
┣ package-lock.json
┗ package.json
Adjustments and improvements
The project is still under development and future updates will focus on the following tasks:
- Add a cli for creating
- Add yarn or npm option
- Add More Templates
💻 Prerequisites
Before starting, make sure you have met the following requirements:
You have installed the latest version of
Node.JS
.for install node.js go to
Node.js Siteand follow the instructions for your SO.
You have installed
GIT
.for install GIT go to
GIT Siteand follow the instructions for your SO.
You have read
this readme.md
.
🚀 Installing s'ipas
To clone s'ipas, follow these steps:
Linux, macOS and windows:
npm i -g sipas
☕ Using s'ipas
CLI sipa:
$ sipas
📫 Contributing to s'ipas
To contribute to s'ipas, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <name_branch>
. - Make your changes and confirm then:
git commit -m '<message_commit>'
- send to original branch:
git push origin sipas / <local>
- Create the pull request.
Alternatively, consult the GitHub documentation how to create a pull request.
😄 Be one of the contributors, add your template
{
url: '<repo_url>',
title: '<repo_title>',
folder_structure: `
ex
┣ index.js
┗ index.spec.js`,
author: '<your_name>'
}
How create a folder strucure?
For add create a folder structure is ust instal that file-tree-generator extension for vs code;