Skip to content

Latest commit

 

History

History
219 lines (150 loc) · 5.9 KB

README.md

File metadata and controls

219 lines (150 loc) · 5.9 KB
Raw

📗 Table of Contents

📖 Commerce Store

Commerce Store is A back-end e-commerce API built with Python, Django, and PostgreSQL that is fully functional and ready to integrate with a front-end UI. It includes endpoints for creating, retrieving, updating, and deleting products, as well as for managing orders, customers, carts, and their items. The API is built on a scalable and secure infrastructure.

🛠 Built With

  • Django

Tech Stack

  • Python
  • Django
  • Django-rest-framework
Server
Database

Key Features

  • Users can buy online
  • Owners can sell their products
  • Implemented high-level security measures

(back to top)

🚀 Live Demo

Not Available yet!

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

To run this project you need:

  • to have Python installed on your machine
  • to have PostgreSQL installed on your machine

Setup

To get a local copy up and running follow these simple example steps.

  1. Navigate to a folder where you want the cloned file to appear

  2. Clone this repo in your terminal or git bash using the command

  cd commerce-store
  git clone https://github.com/degisew/commerce-store.git
  1. Run the following command to install all the necessary dependencies
 cd commerce-store
 pip install pipenv
 pipenv install    # This will create a virtual env't and install dependencies in the virtual env't.
  1. Navigate to the folder called commerce-store/ and open this project using your editor

Usage

To run the project, first activate your virtual environment:

  pipenv shell

Once you have activated, execute the following command to run the server:

cd commerce-store

For Mac/Linux run:
 python3 manage.py runserver

For Windows run:
 python manage.py runserver
  • This above command will start the Django server in your browser

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

Deployment

You can deploy this project using:

  • pythonanywhere
  • Heroku
  • Renderer

(back to top)

👥 Authors

👤 Degisew

(back to top)

🔭 Future Features

  • Integrate with the front-end app
  • Deploy and expose to the public

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give a ⭐️ to repo.

(back to top)

🙏 Acknowledgments

I want to thank all my supporters.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)