https://github.com/mohammad-taheri1/jsmall

https://github.com/mohammad-taheri1/jsmall

cli javascript npm npm-package react typescript

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mohammad-taheri1/jsmall
• Owner: mohammad-taheri1
• License: mit
• Created: 2021-12-25T18:32:35.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-02-21T16:16:51.000Z (over 3 years ago)
• Last Synced: 2024-04-26T01:42:55.028Z (about 2 years ago)
• Topics: cli, javascript, npm, npm-package, react, typescript
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/jsmall
• Size: 2.62 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# jsmall

![GitHub last commit](https://img.shields.io/github/last-commit/MamadTaheri/jsmall)

![GitHub](https://img.shields.io/github/license/MamadTaheri/jsmall)

![npm](https://img.shields.io/npm/v/jsmall)

![npm](https://img.shields.io/npm/dw/jsmall)

![GitHub Repo stars](https://img.shields.io/github/stars/MamadTaheri/jsmall?style=social)

![GitHub pull requests](https://img.shields.io/github/issues-pr/MamadTaheri/jsmall)

![GitHub issues](https://img.shields.io/github/issues/MamadTaheri/jsmall)

## The ultimate React project scaffolder

Jsmall is a command-line interface (CLI) tool that helps you create your react projects with standard foldering and also with typescript. With two simple step, jsmall will automatically create a new project and add the necessary folders and files based on best practices to get you started.

Jsmall helps developers to save time and increase productivity by automating the repetitive task of setting up a new React project, folders and files. It provides a recommended file structure for your project, includes support for TypeScript and ESLint, and provides a basic template for a new project.

  

## Features

You have some  options like:

* React

* React + TypeScript

## Folder Structure

```bash

project-name

├── doc

│   └── docs.MD (file)

├── src

│   ├── assets

│   │   ├── fonts

│   │   └── images

│   ├── components

│   │   └── navbar

│   ├── context

│   ├── core

│   ├── features

│   │   ├── auth

│   │   └── home

│   ├── redux

│   ├── router

│   ├── services

│   ├── types (just for TS projects)

│   └── utils

│       ├── config

│       └── hooks

└── test

   └── sample.spec.js (file)

```

## Installation

You can use this command to install jsmall:

    npm i -g jsmall

## Usage

 Open a new terminal in any location you want to create project and use this command:

    jsmall init

Then, you will see something like this:

## Contributing [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/MamadTaheri/jsmall/issues)

If you are interested in contributing to jsmall, please feel free to submit a pull request or open an issue on the repository.

## Changelog

### v 1.2.3

- fix assets bug

- add features folder

- refactor auth

### v 1.2.2

- fix LogoutComponent bug

- add language to config.json

- add useLayoutEffect to useTitle custom hook

### v 1.2.1

- adding code-generator for react-js folders, files and components