Skip to content

Commit

Permalink
feature: replace seng generator with plopjs
Browse files Browse the repository at this point in the history
  • Loading branch information
edgardz committed Aug 20, 2024
1 parent 859943d commit 2406279
Show file tree
Hide file tree
Showing 31 changed files with 2,164 additions and 6,503 deletions.
2 changes: 1 addition & 1 deletion .adviserrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@
".nvmrc",
".prettierignore",
".prettierrc",
".senggenerator",
".stylelintignore",
".stylelintrc",
"commitlint.config.js",
"lint-staged.config.js",
"next-env.d.ts",
"next.config.js",
"plopfile.js",
"README.md",
"tsconfig.json",
"types.d.ts"
Expand Down
2 changes: 1 addition & 1 deletion .circleci/jobs/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ version: 2.1

default-container: &node-container
docker:
- image: cimg/node:16.15.1
- image: cimg/node:18.19.0

env-suffix-parameter: &env-suffix-parameter
env_suffix:
Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v16.15.1
v18.19.0
8 changes: 0 additions & 8 deletions .senggenerator

This file was deleted.

14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
# Experience.Monks NextJS Generator

![GitHub](https://img.shields.io/github/license/Experience-Monks/nextjs-boilerplate)
# Monks NextJS Generator

> NextJS Boilerplate for static and server side rendered projects
> https://generator.jam3.net
> Icon made by Pixel perfect from www.flaticon.com
---

# Table of Contents
Expand All @@ -24,11 +18,11 @@

## Check your Node and NPM versions

Make sure you are using Node 16.15.1 and NPM 8.11.0 on your development environment to match CircleCI setup. Using NVM is highly encouraged.
Make sure you are using Node 18.19.0 and NPM 10.2.3 on your development environment to match CircleCI setup. Using NVM is highly encouraged.

```properties
$ nvm install 16.15.1
$ nvm use 16.15.1
$ nvm install 18.19.0
$ nvm use 18.19.0
```

> TIP: You can deeply integrate into your shell to automatically invoke NVM when changing directories.: https://github.com/nvm-sh/nvm#deeper-shell-integration
Expand Down
25 changes: 16 additions & 9 deletions docs/template-scripts.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
# Template scripts

We are using [seng-generator](https://github.com/mediamonks/seng-generator) to generate templates
We are using [plop](https://plopjs.com/) to generate files from templates.
You can just run `npm run generate` and follow the instructions, or use the following commands:

```properties
# create a simple component
$ npm run generate component [component-name]
- Create a React component:

# create a page component (the generated files will be automatically prefixed by "Page")
$ npm run generate page [page-name]
```bash
$ npm run generate component [ComponentName]
```

# create a new route (use the same name used for generating the page component)
$ npm run generate route [page-name]
```
- Create a page component (the generated files will be automatically prefixed by "Page")

```bash
$ npm run generate page [PageName]
```

- Create a new route (use the same name used for generating the page component)
```bash
$ npm run generate route [PageName]
```
Loading

0 comments on commit 2406279

Please sign in to comment.