CheshirLvova / ProjectShop

---

ProjectShop

ProjectShop is an Internet-based store that sells different kinds of electronics, either directly or as the middleman between other retailers with main functionality via Telegram-bot, where users can log in using telegram data or a self-created profile.

---

• Installation
  • Required to install
  • Clone
  • How to run
• Git Flow
  • How we add features
• Issue Flow
• Developer Team

---

Installation

---

Required to install

• Python 3.9
• Django 3.2.6

Clone

Clone this repo to your local machine using:
https://github.com/kolyasalubov/ProjectShop.git

How to run

1. Open terminal.
2. Go to the directory ProjectShop.
3. Run docker-compose up
4. Open another terminal and go to directory ProjectShop.
5. Run python manage.py runserver or make run

Git Flow

We have a master(main), development(dev), and feature branches.

All feature branches must be merged into the dev branch!

Only the release should merge into the main branch!!!

All feature branches must be tested before being merged!

All feature branches should start from prefix feature#XXX-YYY - where XXX - number of issue and YYY - short description of the task e.g., feature-#17-Create_README

Don't push features into the main directly!

You should have at least three approves from teammates and final approval from a technical expert before merging your feature.

How we add features

1. Clone this repo to your local machine using https://github.com/kolyasalubov/ProjectShop.git
2. Create a new feature branch from dev.
3. Add some commits to your new branch.
4. Create a new pull request to the dev branch using https://github.com/kolyasalubov/ProjectShop/compare/
5. Request review from teammates and wait for at least three approves from teammates and final approval from a technical expert before merging your feature.
6. Resolve conflicts and merge the feature branch into dev.
7. Run dev to check if all is correct.

---

Issue Flow

1. Go to issues and click New issue button.
2. When creating an issue, you should add the name of the issue, description, choose assignee, label, project. If issue is a User Story, you should link it with corresponding tasks, which should be linked to the issue.
3. If an issue is in work, it should be placed in the right column on the dashboard according to its status.
4. When work on the issue is finished, it should be placed in Done column.

---

Developer Team