Overview:
Relay Fullstack is a Relay scaffolding application that aims to simplify the process of starting a project by integrating multiple tools and technologies. It includes modern technologies such as Relay, GraphQL, Express, ES6/ES7, JSX, Webpack, Babel, Material Design Lite, and PostCSS. The application uses hot-reload to update the screen in real-time whenever any code changes.
Features:
- Integrated with multiple modern technologies: Relay, GraphQL, Express, ES6/ES7, JSX, Webpack, Babel, Material Design Lite, and PostCSS.
- Supports hot-reload for real-time updates.
- Unopinionated and allows customization based on project needs.
- Integrated with Yeoman for choosing technologies such as database and Flow.
Installation:
Basic Installation:
- Install
watchmanby following its installation guide. - Clone the repository to your local directory.
- Install all dependencies.
- Start developing.
- Open your web browser and go to
http://localhost:3000for Relay application orhttp://localhost:8000for GraphiQL.
Advanced Installation:
- Install
yoandgenerator-relay-fullstackglobally. - Create a new directory and start the generator.
- Answer the prompt questions to customize the application.
- Open your web browser and go to
http://localhost:3000for Relay application orhttp://localhost:8000for GraphiQL.
Deployment:
Local Machine:
To deploy the project:
- Minify all JavaScript files.
- Stop spawning the GraphiQL server.
- Pull off duplicate dependencies.
- Remove unnecessary scripts, such as Hot-reload. Execute the following command:
command_here
Then, open your web browser and go to http://localhost:3000.
Heroku:
Before getting started, make sure you have installed the Heroku Toolbelt. To deploy the application:
- Execute the necessary steps using Heroku Toolbelt.
- Open the application on your default browser using
heroku open.
Schema:
Whenever the server is started, the application automatically executes the updateSchema.js script to compile the schema definitions to schema.json and schema.graphql, which are required by Relay framework. You can also manually run the script.
Summary:
Relay Fullstack is a Relay scaffolding application that integrates multiple modern technologies, such as Relay, GraphQL, Express, and more. It simplifies the process of starting a project and provides features such as hot-reload and customization options. The installation process includes basic and advanced options, allowing users to choose technologies based on their needs. The deployment process includes steps for deploying on a local machine and on Heroku. The application also provides a script for compiling schema definitions required by the Relay framework.