Skip to content

This was a semester project for the subject software development.

License

Notifications You must be signed in to change notification settings

florianpfleiderer/coffee-app

Repository files navigation

Getting Started with the application

To run this project in a docker container, go to the projects root folder and follow these commands:

docker-compose up

After this, you should see the containers for frontend and backend up and running in your docker application.

Getting Started with Create React App

This project was bootstrapped with Create React App. The Axios Library is used for API Requests. We are using the yarn package manager (-> please don't run any npm or other package manager commands)

Flask

Please initiate virtual environment with the name 'venv' to use yarn start-api.

cd api

python3 -m venv venv

Please run (to install all requirements in your virtual environment):

pip install -r requirements.txt

installing Librarys

yarn install
yarn add <name>

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

yarn start-api

Runs the Flask API at port 5000.
Open http://localhost:5000/api to seperatly view it in your browser (most of the times there will be no output).

When you make changes in the Code and save them, the Console will detect this and reload

yarn test

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

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

yarn 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