https://github.com/Devgametools/coffee_shop
DJANGO APP
https://github.com/Devgametools/coffee_shop
Last synced: 9 months ago
JSON representation
DJANGO APP
- Host: GitHub
- URL: https://github.com/Devgametools/coffee_shop
- Owner: Devgametools
- Created: 2025-01-18T05:07:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-22T02:35:02.000Z (over 1 year ago)
- Last Synced: 2025-03-10T15:58:08.825Z (over 1 year ago)
- Language: Python
- Size: 175 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Coffee Shop
===========
Welcome to the Coffee Shop project! This Django application is designed to manage a coffee shop's products, orders, and users efficiently.
Requirements
------------
* **PostgreSQL** (Make sure it's installed and running)
* **Python 3.11**
Installation Guide
------------------
Follow these steps to get the project up and running on your local machine.
### 1\. Clone the Repository
Clone the project repository from GitHub to your local machine.
```bash
git clone https://github.com/RobertBass/coffee_shop.git
cd coffee_shop
```
### 2\. Set Up Virtual Environment
Create and activate a virtual environment.
```bash
python3.11 -m venv name_of_virtual_environment
source name_of_virtual_environment/bin/activate
```
### 3\. Install Dependencies
Install the required Python packages using `pip`.
`pip install -r requirements.txt`
### 4\. Configure Environment Variables
Create a `.env` file in the root of the project. You can use `.env.example` as a template.
`cp .env.example .env`
Update the `.env` file with your database credentials and other necessary configurations.
### 5\. Set Up the Database
Create the PostgreSQL database and apply migrations.
```bash
psql -U postgres CREATE DATABASE coffeeshop;
```
Apply migrations
```bash
python manage.py migrate
```
### 6\. Create a Superuser
Create a superuser to access the Django admin interface.
```
python manage.py createsuperuser
```
### 7\. Run the Development Server
Start the Django development server.
```
./manage.py runserver
```
Access the project by navigating to `http://127.0.0.1:8000` in your web browser.
Project Structure
-----------------
* **products**: Handles everything related to coffee products.
* **users**: Manages user authentication and profiles.
* **orders**: Manages customer orders.
Contributing
------------
We welcome contributions! Please fork the repository and submit pull requests for any features, improvements, or bug fixes.