kandimat/redaktions-app
Christoph Lienhard f7a56a0bed Rename candymat -> kandimat everywhere
Furthermore, submodule link to new public repo
2022-02-02 15:06:13 +01:00
..
public Rename candymat -> kandimat everywhere 2022-02-02 15:06:13 +01:00
src Rename candymat -> kandimat everywhere 2022-02-02 15:06:13 +01:00
.dockerignore Fix docker compose setup and add redaktions app 2020-01-31 23:01:08 +01:00
.eslintrc.yml several minor changes in user management 2021-05-17 20:54:58 +02:00
.graphqlconfig #6 Start from scratch with redaktionsapp 2020-08-23 13:13:09 +02:00
.prettierignore Add prettier for redaktions-app 2021-01-09 12:49:28 +01:00
.prettierrc.json Add prettier for redaktions-app 2021-01-09 12:49:28 +01:00
README.md #20 Run prettier on the whole redaktions-app source 2021-05-29 00:00:10 +02:00
dev.Dockerfile #7 Introduce react-router 2020-08-23 18:37:08 +02:00
logo.svg #20 Run prettier on the whole redaktions-app source 2021-05-29 00:00:10 +02:00
package-lock.json #20 Run prettier on the whole redaktions-app source 2021-05-29 00:00:10 +02:00
package.json Do not run tests on commit 2021-06-13 11:51:31 +02:00
prod.Dockerfile Fix docker compose setup and add redaktions app 2020-01-31 23:01:08 +01:00
tsconfig.json Fix "used before it was defined" warning 2021-02-07 23:06:58 +01:00

README.md

Redaktions App

The "Redaktions App" or editor's app is the main gateway for editors and candidates to alter the database, e.g. adding new questions (editors) and answering them (candidates).

Development

The app is written in typescript and react and uses apollo to query the backend and as a local store.

Setup

  • Install npm
  • In this directory run npm ci to install all dependencies according to the package.json and package-lock.json.

Develop locally

  • In the parent directory run
    docker-compose up
    
    which will start the whole setup including this app in a dockerfile. However, rebuilding and restarting this image can be cumbersome and is not necessary in the development setup.
  • Instead run
    npm start
    
    and access the app at http://localhost:3000.

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.

Running the app without the backend server makes little sense. Start it under http://localhost:5000 as specified in the Readme of the backend server (../backend)

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 cant go back!

If you arent 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 youre on your own.

You dont have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldnt feel obligated to use this feature. However we understand that this tool wouldnt be useful if you couldnt customize it when you are ready for it.