https://github.com/nmrshll/frontend-scaffolds
Front end scaffolds
https://github.com/nmrshll/frontend-scaffolds
bash cli eslint generator javascript react scaffold shell webpack yeoman
Last synced: 3 months ago
JSON representation
Front end scaffolds
- Host: GitHub
- URL: https://github.com/nmrshll/frontend-scaffolds
- Owner: nmrshll
- License: mit
- Created: 2018-10-18T16:14:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T21:53:13.000Z (over 3 years ago)
- Last Synced: 2023-02-28T10:01:33.826Z (over 3 years ago)
- Topics: bash, cli, eslint, generator, javascript, react, scaffold, shell, webpack, yeoman
- Language: JavaScript
- Size: 2.05 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# frontend-scaffolds
Different sets of pre-configured front-end projects to copy-paste and get started coding. Each branch is one project/configuration.
## Installation
This project requires:
- NodeJS 10+ ([installation instructions](https://nodejs.org/en/download/package-manager/))
- yarn (or npm) ([installation instructions](https://yarnpkg.com/en/docs/install))
- [saojs](https://saojs.org/guide/getting-started.html). All it does is copy an existing repo/branch into a fresh repo on your machine.
- Install by running `yarn global add sao`
- (or `npm i -g sao`)
- (or [use this bash function instead of sao](./docs/alternative-bash-function.md))
## Usage
Run the following command with the {branch_name} that holds the project you want to clone:
```sh
sao nmrshll/frontend-scaffolds#{branch_name}
```
## Available scaffolds
Each branch of this project holds a different scaffold:
- for an ejected create-react-app 2.0 setup: `sao nmrshll/frontend-scaffolds#CRA2.0`
- react with tailwindCSS: `sao nmrshll/frontend-scaffolds#react-tailwind`
- react-static with tailwindCSS: `sao nmrshll/frontend-scaffolds#react-static-tailwind`
- react-static: `sao nmrshll/frontend-scaffolds#react-static`
- react-static, apollo-graphql: `sao nmrshll/frontend-scaffolds#react-static-graphql`
- CRA3, testing: `sao nmrshll/frontend-scaffolds#cra3-jest-enzyme`
- CRA3, testing, unstated3: `sao nmrshll/frontend-scaffolds#cra3-unstated`
- CRA3, testing, unstated3, tailwind: `sao nmrshll/frontend-scaffolds#cra3-unstated-tailwind`
Master has a create-react-app 2.0 setup: `sao nmrshll/frontend-scaffolds`
For mobile:
- CRNA + React-navigation: `sao nmrshll/frontend-scaffolds#crna-rnavigation`
## Adding your own scaffolds
For custom project scaffolds, fork the repo, then edit any existing branch or add new ones.
Notice how the sao command requires you to pass `username/repo` as the first argument ?
To use your fork instead, replace that with `your_username/your_fork_repo_name` and you'll be good to go.