74 lines
2.8 KiB
Markdown
74 lines
2.8 KiB
Markdown
# 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
|
||
```shell script
|
||
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
|
||
```shell script
|
||
npm start
|
||
```
|
||
and access the app at [http://localhost:3000](http://localhost:3000).
|
||
|
||
#### Available Scripts
|
||
|
||
In the project directory, you can run:
|
||
|
||
##### `npm start`
|
||
|
||
Runs the app in the development mode.<br>
|
||
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
|
||
|
||
The page will reload if you make edits.<br>
|
||
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](http://localhost:5000) as specified in the Readme of the backend server (../backend)
|
||
|
||
##### `npm test`
|
||
|
||
Launches the test runner in the interactive watch mode.<br>
|
||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more
|
||
information.
|
||
|
||
##### `npm run build`
|
||
|
||
Builds the app for production to the `build` folder.<br>
|
||
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.<br>
|
||
Your app is ready to be deployed!
|
||
|
||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/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.
|