Express Generator CLI for React with Typescript, Apollo GraphQL Client and Material UI

This CLI helps to create new implemented front-end demo for React with Typescript, Apollo GraphQL Client and Material UI from a boilerplate. To have a Full Stack project, or to test created demo, you can setup graphql server with using Express Generator CLI for Graphql Backend

About the NPM Package

Package Installation

npm install -g express-generator-react-typescript-material-apollo-graphql

Package Usage

Go to the directory on terminal where you want to generate the project.

$ cd PATH

and run the generator command with specifying the project name.

$ express-generator-rtmag --name="PROJECT_NAME"

Documentation for the Boilerplate

When you generate the project, you will have;

Tech Stack

• Node.js
• Typescript
• GraphQL Apollo Client
• Material UI
• Global Store Manager

Features

• GraphQL Queries with implementations in Typescript for Demo User Entity
• GraphQL Mutations with implementations in Typescript for Demo User Entity
• CRUD operations in Typescript for Demo User Entity
• Full Ready CRUD Demo User Components: User List Component, Single User Component, User Dialog Component

Architecture

This boilerplate has common graphql client design architecture. Layers:

• Components holds component implementations
• Models holds document interfaces and schema models
• Mutations holds basic mutation scripts to send graphql server; create, update, delete
• Queries holds basic query scripts to send graphql server; retrieve

Installation

Install the dependencies and devDependencies:

$ cd <Project Name>
$ npm install

Set configuration parameters on config/index.ts:

GRAPHQL_URL: "{{GRAPHQL API URL}}"

And that's all, start the client

$ npm start

Documentation for the Generator Project

Tech Stack

• Node.js
• Typescript

Plugins

express-generator-rtmag is currently extended with the following plugins. Instructions on how to use them in your own application are linked below.

Plugin	Usage
ejs	to render global parameters like Project Name
inquirer	to ask questions and parse input
shelljs	to eliminate your shell script's dependency on Unix
yargs	to build interactive command line tools
shx	to wrap around ShellJS Unix commands
ts-node	to execute TypeScript and REPL for node.js, with source map support

Installation

express-generator-rtmag requires Node.js v10+ to run.

Install the dependencies and devDependencies and start the application.

$ cd express-generator-react-typescript-material-apollo-graphql
$ npm install
$ npm start

To install the CLI globally:

$ npm run-script build
$ npm install -g .

And global usage:

$ express-generator-rtmag --name="PROJECT_NAME"

Authors

• Fatih Türker

Sponsors

No sponsors yet! Will you be the first?

Contributors

No contributers yet! Will you be the first?

License

---

MIT