trite / following-relay-newsfeed-tutorial

Following along with a tutorial

This is just me following along with the relay.dev docs tutorial. Doing it in git as a reference for future me mainly.

Newsfeed Application Example

The Relay application is designed to be used in conjunction with the Relay documentation to demonstrate the APIs, concepts, and principles of Relay and their use in building Relay applications.

Getting Started

To get started with this project, follow these steps:

1. Clone the repository to your local machine
2. Install the dependencies by running npm install
3. Start the app by running npm run dev

The application will now be running at localhost:3000. This application also has GraphiQL setup so that you can run test queries against the schema. Navigate to localhost:3000/playground to try it out.

Project Structure

This project uses the following structure:

• src/: contains the source code for the app
• src/components/: contains the React components for the app
• src/index.tsx: the entry point for the app
• webpack.config.js: the configuration file for Webpack
• tsconfig.json: the configuration file for TypeScript
• .prettierrc.json: the configuration file for Prettier
• .eslintrc.json: the configuration file for ESLint

Typescript, Prettier and Lint

This project uses Prettier and ESLint to enforce a consistent code style. Prettier is a code formatter that automatically formats your code according to a set of rules. ESLint is a linting tool that identifies and reports on patterns found in your code.

To run TypeScript, Prettier, and ESLint, run the following command:

  npm run ts

  npm run lint

  npm run prettier

These commands lint and format your code, and print any linting errors or warnings to the console.

Additional Resources

• Relay documentation
• React documentation
• Webpack documentation
• TypeScript documentation
• Prettier documentation
• ESLint documentation