Skip to content

Latest commit

 

History

History
executable file
·
110 lines (64 loc) · 5.06 KB

README.md

File metadata and controls

executable file
·
110 lines (64 loc) · 5.06 KB

admin-frontend Netlify Status

This is the frontend of the admin interface, used internally @Vochabular for the creation, translation, reviewing and publishing of content.

Introduction

This single-page-application (SPA) is written in Typescript and React and is bootstrapped with Create React App.

How to install

  • Install a the package manager npm
  • Based on the .env.example file, set the necessary environment variables in the .env file. The Auth0 variables you can get from the Auth0 Dashboard under "Applications".
  • Clone the git repository with git clone https://github.com/vochabular/admin-frontend
  • Install all required packages with npm install

How to work with React, GraphQL and the Backend

We use GraphQL, a typed query language, as an interface between the SPA Client and the backend. The backend provides with a self-documenting, interactive "Graph" explorer which you can access here:

https://vochabular-admin.herokuapp.com/api/graphql

The schema is publicly available. But if you login first to the Django admin interface, then it will use the cookie (?) as a session var

Additional steps to generate types with Apollo Codegen

  • Install the apollo package globally: npm install -g apollo
  • Make sure that the settings in apollo.config.js in the root directory are correct
  • Write a new GraphQL query, preferably in the "queries" directory
  • Then generate the types with: apollo client:codegen --target typescript
  • This should generate some files in a generated folder. You can then import these types and use them in your components...

Note:

Below is the original README.md from create-react-app

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

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify