Skip to content

Commit

Permalink
shifting to v1.1.3 version of code.
Browse files Browse the repository at this point in the history
- docs updated
- package version updated
- readme updated
  • Loading branch information
OurCodeBase committed Oct 2, 2024
1 parent ed0e519 commit 5b6e352
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 30 deletions.
40 changes: 29 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Gen3 Express
A gen3 tool to generate express app boilerplate.
A gen3 tool to generate express app.

## Acknowledgements
You need to know atleast basics about these things.
Expand All @@ -25,32 +25,48 @@ npm install -g gen3-express
gen3-express my-app
```

## Tailwind CSS
To get tailwind css boilerplate, you can add `-t` or `--tailwindcss` switches or flags while generating a site.
```bash
npx gen3-express my-app --tailwindcss
```

### Usage
To add tailwindcss to your `EJS` page, use `css/tailwind.css` into a `link` tag.
```html
<link href="css/tailwind.css" rel="stylesheet">
```
Because of `tailwind` updates css file according your needs, We need to run a `tailwind` sever with command below.
```bash
npm run tailwind
```
- If you choosed tailwind css boilerplate then this server will run with `dev` keyword server.

## Documentation
To install all dev dependencies goto the folder and hit `npm install` command.
To install all dependencies goto the folder and execute `npm install` command.
```bash
cd my-app
npm install
```
To start a dev server to preview page use `server` word.
- Keep in mind that
- The below command does not include EJS live reloading.
To start a dev server to preview page use `server` keyword.
- Keep in mind that the below command does not provide live reloading in `EJS` and `public` files.

```bash
npm run server
```
To start a dev server to live preview EJS page use `sync` word.
To get live reloading in `EJS` and `public` folder, create another server with `sync` keyword.
```bash
npm run sync
```
If you want to run all these servers together then you should to use this below command, this command will provide you hot reloadings in every place.
```bash
npm run server & npm run sync
npm run dev
```

## File Cases
To know about the product or project structure read about files included in this code block.
## File Tree
To know about the project structure read about files included in this code block.

```bash
```yml
.
├── app.js
├── package.json
Expand All @@ -70,8 +86,10 @@ To know about the product or project structure read about files included in this

- Custom name in `package.json` file ✅
- Excellent terminal user interface ✅
- Prompt `package.json` file's details from user. ⏩
- Post this project to npmjs website. ✅
- Add Tailwind CSS support. ✅
- Use a lightweight server for EJS live reloading. ⏩
- Prompt `package.json` file's details from user. ⏩
- Custom local template feature ⏩

## Authors
Expand Down
6 changes: 6 additions & 0 deletions docs/changelogs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Changelogs
You can check most latest changlogs at [commits](https://github.com/OurCodeBase/gen3-express/commits/main/) or [versions](https://github.com/OurCodeBase/gen3-express/releases) sections in github.

## 1.1.3 is released

This comment has been minimized.

Copy link
@OurCodeBase

OurCodeBase Oct 2, 2024

Author Owner

1.1.3 is released needs to change to Changelogs 1.1.3

tailwind css support is added.
- a new file `tailwind.config.js` is created for tailwind users.
- multiple server runs shifted to single `dev` keyword command.
- all dependencies has been updated.

## Changelogs 1.1.2
boilerplate has been optimised, enhanced and documented.
- `style.css` file is shifted to `public/style.css`
Expand Down
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,7 @@ features:
- icon:
title: Cross Platform
details: You can use this tool on any platform like Linux, MacOS, Windows (WSL) and also on Android (Termux).
- icon: 🍃
title: Tailwind CSS (new)
details: You can include tailwind css to your site with one switch while generate.
---
52 changes: 34 additions & 18 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
# Gen3 Express
A gen3 tool to generate express app boilerplate.
A gen3 tool to generate express app.

> [!IMPORTANT]
> ### 1.1.2 is released
> boilerplate has been optimised, enhanced and documented.
> - `style.css` file is shifted to `public/style.css`
> - `nets` file is shifted to `netface`
> - github `readme` file is shifted to `docs` folder.
> - `.gitignore` has been added.
> ### 1.1.3 is released
> tailwind css support is added.
> - a new file `tailwind.config.js` is created for tailwind users.
> - multiple server runs shifted to single `dev` keyword command.
> - all dependencies has been updated.
## Acknowledgements
You need to know atleast basics about these things.
Expand All @@ -34,32 +32,48 @@ npm install -g gen3-express
gen3-express my-app
```

## Tailwind CSS
To get tailwind css boilerplate, you can add `-t` or `--tailwindcss` switches or flags while generating a site.
```bash
npx gen3-express my-app --tailwindcss
```

### Usage
To add tailwindcss to your `EJS` page, use `css/tailwind.css` into a `link` tag.
```html
<link href="css/tailwind.css" rel="stylesheet">
```
Because of `tailwind` updates css file according your needs, We need to run a `tailwind` sever with command below.
```bash
npm run tailwind
```
- If you choosed tailwind css boilerplate then this server will run with `dev` keyword server.

## Documentation
To install all dev dependencies goto the folder and hit `npm install` command.
To install all dependencies goto the folder and execute `npm install` command.
```bash
cd my-app
npm install
```
To start a dev server to preview page use `server` word.
- Keep in mind that
- The below command does not include EJS live reloading.
To start a dev server to preview page use `server` keyword.
- Keep in mind that the below command does not provide live reloading in `EJS` and `public` files.

```bash
npm run server
```
To start a dev server to live preview EJS page use `sync` word.
To get live reloading in `EJS` and `public` folder, create another server with `sync` keyword.
```bash
npm run sync
```
If you want to run all these servers together then you should to use this below command, this command will provide you hot reloadings in every place.
```bash
npm run server & npm run sync
npm run dev
```

## File Cases
To know about the product or project structure read about files included in this code block.
## File Tree
To know about the project structure read about files included in this code block.

```bash
```yml
.
├── app.js
├── package.json
Expand All @@ -79,8 +93,10 @@ To know about the product or project structure read about files included in this

- Custom name in `package.json` file ✅
- Excellent terminal user interface ✅
- Prompt `package.json` file's details from user. ⏩
- Post this project to npmjs website. ✅
- Add Tailwind CSS support. ✅
- Use a lightweight server for EJS live reloading. ⏩
- Prompt `package.json` file's details from user. ⏩
- Custom local template feature ⏩

## Authors
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "gen3-express",
"version": "1.1.2",
"version": "1.1.3",
"description": "A gen3 tool to generate express app boilerplate.",
"bin": {
"gen3-express": "./bin/gen3-express.js"
Expand Down

0 comments on commit 5b6e352

Please sign in to comment.