Shipp It

Welcome To Supply Chain App [ Shipp It ]

Goal

To create a full solution[web+app] for the entire supply chain from receiving the order from an e-com/store to sending it to the end user .

About

"Shipp It" is a Full-scale logistic service. Using "Shipp It" big companies to individual small sellers anyone can deliver their product to their desired customer. This software will be ready to use, for any kind of users and at any scale - from the business class to startup and individual level. Different role based authentication and accesses will let individual seller get more clarity for their small business. It will also give real time updates of the products with location tracking. Proper details for any kind of delay or late shipment will be conveyed directlty by the delivery personal from very interactive app.

Features

• Real time tracking with multi admin system
• User friendly interactive platform
• Different permission based dashboard/ features for supporting startup
• OTP based authentication

Languages & Tools

• Python, Django, Django-Rest-Framework(DRF)
• Flutter, React
• HTML, CSS, Javascript
• PostgreSQL

Maintainers

• Saikat Mukherjee

Participated under [JWoC 2K22]

Mentor

Mentor for this project is Saikat Mukherjee. Github profille :- https://github.com/7saikat7

Saikat Mukherjee

Django app setup guidelines 🚀

Development Environment Setup: Windows

Step 1: Fork the Repository

Step 2: Creating Project Directory

cd desktop
mkdir myprojects
cd myprojects

Step 3: Cloning Repository using Git

git clone https://github.com/'<your-github-username>'/supply_chain.git

Step 4: Change directory to supply_chain

cd supply_chain

Step 5: Add a reference to the original repository

git remote add upstream https://github.com/7saikat7/supply_chain.git

Step 6: Creating Virtual Environment

pip3 install virtualenv

Creating Virtual Environment named myvenv

virtualenv myvenv -p python3.9

To Activate myvenv

myvenv\Scripts\activate

To deactivate myvenv

deactivate

Step 7: Installing Requirements

pip install -r requirements.txt

Step 8: Making database migrations

python manage.py makemigrations
python manage.py migrate

Step 9: Creating superuser to access Admin Panel

python manage.py createsuperuser

Step 10: Running the Project in local server

python manage.py runserver

Contribution guidelines 🔐

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. To contribute to this project you first need to fork this repository Fork this repository. To fork it click on the fork

2. Clone your forked copy of the project. To clone open git bash in your device and type the following command

git clone https://github.com/<your github username>/supply_chain.git

3. Now open git bash in cloned repository folder

4. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/7saikat7/supply_chain.git

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).

git pull upstream main

7. Create a new branch.

git checkout -b <your_branch_name>

8. Perform your desired changes to the code base.

9. Track your changes:heavy_check_mark: .

git add . 

10. Commit your changes .

git commit -m "Relevant message"

11. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

12. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.

13. Add appropriate title and description to your pull request explaining your changes and efforts done.

14. Click on Create Pull Request.

Happy Contributing