Skip to content

Commit

Permalink
📝 (README) - Add screenshots into README files
Browse files Browse the repository at this point in the history
  • Loading branch information
baptistelechat committed Mar 2, 2024
1 parent 53b3fe9 commit 26a7d1d
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 3 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ A boilerplate for easily bootstrap a new project using NextJS.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

![baptistelechat-boilerplate](./screenshot/baptistelechat-boilerplate.png)


### 🚩 Prerequisites

You have to install node on your machine : https://nodejs.org/en/download/
Expand Down
10 changes: 7 additions & 3 deletions cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ A CLI for use baptistelechat-boilerplate for easily bootstrap a new project usin

These instructions will guide you on how to install and use the Baptiste LECHAT Boilerplate CLI to create a new project.

![create-new-project](./screenshot/create-new-project.png)


### 🚩 Prerequisites

You have to install node on your machine : https://nodejs.org/en/download/
Expand All @@ -30,11 +33,11 @@ Step 1 → After installing the CLI, run this command with the project name :

You can also use npx or yarn dlx or pnpm dlx to run the CLI without installing it globally:
```bash
npx @baptistelechat/boilerplate -i yarn -n my-new-project
npx @baptistelechat/boilerplate -n my-new-project
# or
yarn dlx @baptistelechat/boilerplate --installer npm -n my-new-project
yarn dlx @baptistelechat/boilerplate -n my-new-project
# or
pnpm dlx @baptistelechat/boilerplate -i pnpm -n my-new-project
pnpm dlx @baptistelechat/boilerplate -n my-new-project
```

Step 2 → Navigate to the newly created project directory :
Expand Down Expand Up @@ -95,6 +98,7 @@ Display help information for the CLI:
# or
@baptistelechat/boilerplate --help
```
![help](./screenshot/help.png)

## 🏗 Boilerplate built With

Expand Down
Binary file added cli/screenshot/create-new-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added cli/screenshot/help.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions next-env.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/// <reference types="next" />
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
Binary file added screenshot/baptistelechat-boilerplate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 26a7d1d

Please sign in to comment.