huygensing/timbuctoo-gui repository overview

⁠Timbuctoo ING - Graphical User Interface

A Graphical interface for users to inspect, create and maintain datasets

⁠Personal settings

In the .env file, you can add these variables, which will affect the application:

⁠REACT_APP_BACKEND_URL : string URL

You can set the api url for timbuctoo endpoint that you want to connect to the project.

⁠REACT_APP_LOGIN_URL : string URL

This expects the url the application posts to when attempting a login. The key that is stored in the query-parameter after logging in will be stored in a cookie, so a user doesn't have to log in every time

⁠Available Scripts

In the project directory, you can run:

⁠npm 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.

⁠npm test

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

⁠npm run 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.

⁠npm run gql-ts

To make sure your Typescript file stays up-to-date with the schema, this command updates the ts from the schema.faker.graphql file. Saves some time in endlessly converting graphql to typescript.

⁠npm run 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.

⁠Grid explained

The grid used in this project is based on VW instead of px's or percentages. The biggest advantage is that grid-nesting all maintain the same sizing. Just like what REM does against EM. This grid is based on 48 points.

The grid has two different components:

• <Grid />: which explains the width of the area you want to set
• <Col />: which is used to define columns inside each grid

Keep in mind:

• Both components have sizes and offsets to declare:
  • for all xs
  • from mobile to tablet sm
  • everything above tablet md
• No default sizes are given to Cols and Grids. This means that without values, they grow to the full width of the monitor, even if they are nested inside a grid that specifies less than 48 points.

⁠Supported Language Features and Polyfills

This project supports a superset of the latest JavaScript standard.
In addition to ES6⁠ syntax features, it also supports:

• Exponentiation Operator⁠ (ES2016).
• Async/await⁠ (ES2017).
• Object Rest/Spread Properties⁠ (stage 3 proposal).
• Dynamic import()⁠ (stage 3 proposal)
• Class Fields and Static Properties⁠ (stage 2 proposal).
• JSX⁠ and TypeScript⁠ syntax.

Learn more about different proposal stages⁠.

While we recommend to use experimental proposals with some caution, Facebook heavily uses these features in the product code, so we intend to provide codemods⁠ if any of these proposals change in the future.

Note that the project only includes a few ES6 polyfills⁠:

• Object.assign()⁠ via object-assign⁠.
• Promise⁠ via promise⁠.
• fetch()⁠ via whatwg-fetch⁠.