cra-template-wundergraph-typescript

0.4.0 • Public • Published

This project was bootstrapped with Create React App.

Getting Stared (wundergraph)

setup your environment

This only needs to be done once per machine.

Go to https://console.wundergraph.com/profile and copy the environment setup. Put it into your bash profile, zshrc or similar and make sure to source the config file or re-open your terminal before moving on.

configure your development WunderNode

Go to https://console.wundergraph.com/wundernodes, select the node you'd like to use and copy paste the configuration for both .env and docker-compose.yml.

configure package.json

Replace YOUR_APPLICATION_NAME & YOUR_AUTH_CLIENT_NAME with the correct names from the application you'd like to use. You can find the application at https://console.wundergraph.com/applications. YOUR_APPLICATION_NAME is "Name" in the "CONFIG" Tab. YOUR_AUTH_CLIENT_NAME is "id" of the Client you'd like to use in the "Auth" Tab of your application. If you don't yet have a client make sure to create one.

run your WunderNode

Run npm run/yarn wundernode-up to start your WunderNode. Make sure your application is deployed on your WunderNode. See "DEPLOYMENTS" Tab in your Application.

generate your client

The ./src/client directory is just a boilerplate client. Before you can start make sure to run npm run/yarn generate-client or generate-client-watch.

ready to go

  1. setup your dev environment
  2. setup and start your WunderNode
  3. configure your package.json and generate your client
  4. run your React Application

Available Scripts (wundergraph)

generate-client

Retrieves the configuration for the app and (re-) generates the client.

generate-client-watch

Continously retrieves the configuration for the app and (re-) generates the client in case the config changed.

wundernode-up

Start wundernode and etcd using docker-compose.

wundernode-down

Stop wundernode and etcd using docker-compose. The state of etcd (e.g. sessions) will be kept. You have to manually purge the volumens if you want to evict the state.

Available Scripts (create react app)

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Readme

Keywords

none

Package Sidebar

Install

npm i cra-template-wundergraph-typescript

Weekly Downloads

0

Version

0.4.0

License

MIT

Unpacked Size

54.9 kB

Total Files

27

Last publish

Collaborators

  • jens-wundergraph