steve
/
keepyourmouthshut
mirror of https://github.com/ninjas-code-official/food-delivery-singlevendor
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
keepyourmouthshut/docs/usage.md

21 lines
546 B
Markdown
Raw Normal View History

docs: update project documentation - Updated project documentation to include the latest information, changes, and improvements for better clarity and understanding.
2023-11-15 14:19:56 +00:00
# How to use KeepYourMouthShut
chore: update dependency requirements and documentation setup - Updated requirements.txt to reflect changes in dependencies. - Installed all necessary dependencies, including development dependencies. - Implemented documentation using MkDocs with the Material theme for comprehensive project documentation.
2023-11-10 15:19:41 +00:00
docs: update project documentation - Updated project documentation to include the latest information, changes, and improvements for better clarity and understanding.
2023-11-15 14:19:56 +00:00
## Using the GitHub repository
chore: update dependency requirements and documentation setup - Updated requirements.txt to reflect changes in dependencies. - Installed all necessary dependencies, including development dependencies. - Implemented documentation using MkDocs with the Material theme for comprehensive project documentation.
2023-11-10 15:19:41 +00:00
docs: update project documentation - Updated project documentation to include the latest information, changes, and improvements for better clarity and understanding.
2023-11-15 14:19:56 +00:00
1. Clone the GitHub repository:\
`git clone https://github.com/rajtilakjee/keepyourmouthshut.git`
2. Create a virtual environment using `venv`\
`python -m venv .venv`
3. Activate the virtual environment\
`.venv\Script\activate`
4. Install the dependencies\
`pip install -r requirements.txt`
5. Run the app\
`streamlit run src/main.py`
chore: update dependency requirements and documentation setup - Updated requirements.txt to reflect changes in dependencies. - Installed all necessary dependencies, including development dependencies. - Implemented documentation using MkDocs with the Material theme for comprehensive project documentation.
2023-11-10 15:19:41 +00:00
docs: update project documentation - Updated project documentation to include the latest information, changes, and improvements for better clarity and understanding.
2023-11-15 14:19:56 +00:00
## Using the Docker image
chore: update dependency requirements and documentation setup - Updated requirements.txt to reflect changes in dependencies. - Installed all necessary dependencies, including development dependencies. - Implemented documentation using MkDocs with the Material theme for comprehensive project documentation.
2023-11-10 15:19:41 +00:00
docs: update project documentation - Updated project documentation to include the latest information, changes, and improvements for better clarity and understanding.
2023-11-15 14:19:56 +00:00
1. Pull the Docker image\
`docker pull rajtilakjee/keepyourmouthshut:1.0.0`
2. Start using the image