https://github.com/halkeye/digitalocean-api-graphql-frontend
https://github.com/halkeye/digitalocean-api-graphql-frontend
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/halkeye/digitalocean-api-graphql-frontend
- Owner: halkeye
- Created: 2024-04-08T22:47:27.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-14T20:53:31.000Z (about 1 year ago)
- Last Synced: 2025-03-23T22:16:34.203Z (2 months ago)
- Language: TypeScript
- Size: 17.8 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Digitalocean API Graphql Example
A relay based application to play around with graphql. For testing out https://github.com/halkeye/digitalocean-graphql-api
## 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`](http://localhost:3000). This application also has [GraphiQL](https://github.com/graphql/graphiql) setup so that you can run test queries against the schema. Navigate to [`localhost:3000/playground`](http://localhost:3000) 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:
```sh
npm run ts
```
```sh
npm run lint
```
```sh
npm run prettier
```
These commands lint and format your code, and print any linting errors or warnings to the console.
## Additional Resources
- [Relay documentation](https://relay.dev)
- [React documentation](https://reactjs.org/docs/getting-started.html)
- [Webpack documentation](https://webpack.js.org/concepts/)
- [TypeScript documentation](https://www.typescriptlang.org/docs/home.html)
- [Prettier documentation](https://prettier.io/docs/en/index.html)
- [ESLint documentation](https://eslint.org/docs/user-guide/getting-started)