create-treg-app

A command to create a starter app built with Typescript, React, Express, and GraphQL.

What does TREG mean? T = Typescript R = React E = Express G = GraphQL

Don't judge, naming is hard!

Getting Started

You will need to have node on your computer to use this command. To install node, check out the official documentation at https://nodejs.org/en/

1.) Open up a terminal/cmd, and you should be able to run the command npm install create-treg-app yarn -g.

2.) Then go to the desired destination of your project and run the command create-treg-app ExampleProject. You can replace 'ExampleProject' with the desired name of your project.

As you can see, the command generated a new directory called ExampleProject.

3.) cd into the project. In my case, I run cd ExampleProject. I can then see two directories, client and server. Go into the client directory and run the command yarn. This will install all the dependencies required for the front-end. After you install these dependencies, run the command npm run build.

4.) Now go into the server directory and run yarn. Run the command npm start app and you should see an app server spin up at localhost:8080 and a graphql server spin up at localhost:3000. The app server serves your react project, whilst the graphql server provides the graphql.

Now that your server is running, you can go to localhost:3000 to see GraphiQL. https://github.com/graphql/graphiql

And to see your react application, go to localhost:8080.

Notable Dependencies

• Typescript - https://www.typescriptlang.org/
• React - https://reactjs.org/
• Express.js - https://expressjs.com/
• GraphQL - http://graphql.org/
• Apollo (specifically react-apollo) - https://github.com/apollographql/react-apollo

Feel free to post issues in the issues log and I will try to address them as soon as possible. If you think you can fix an issue, feel free to make a Pull Request. Thanks!