Flask base & POS software
Project description
Featured on Weekly Python issue 436 🌟
🎁 Open inventory management and Point of sales (powered by python) for small shops.
- :sparkler: Plug and Play modules
- :sparkler: Themes!
It also makes a great Flask base and supports commands such as:
python manage.py startapp loans
Test it out!
Info | Value |
---|---|
Link | shopyo.pythonanywhere.com |
Credentials | User: testuser - password: pass |
By code
[Important] Create a virtual environment and activate it (not needed when installing via github).
pip install shopyo
then
shopyo new /home/profiles/arj/desktop shopyotest
then cd into the folder
cd /home/profiles/arj/desktop/shopyotest
then install requirements
pip install -r requirements.txt
then
python manage.py initialise # or `shopyo initialise`
python manage.py runserver # or `shopyo runserver` or rundebug
go to url ^^
Note: If the command does not get recognised, close and reopen your cmd
default login
mail: admin@domain.com
password: pass
⚗️ Stability
beta - now in beta! - Not fully ready to be used by people without Flask knowledge.
Note: since we are adding ecommerce as a demo, we don't guarantee security. It is currentlty your duty to assume the security aspects. Though the project is MIT licensed, we thought of warning you. The project gets better and better, we hope to provide a SOLID project, but as we continously switch to a better version of an aspect, we have not reached 'the' point where you can just take and install it at a client's place. Currently you need to flask-audit the code and see what you'd like to modify.
💌 Contributing Countries
🇲🇺 🇩🇪 🇨🇳 🇬🇧 🇸🇬 🇺🇬 🇲🇽
🔥 Default Modules:
Basics:
- Control Panel
- Admin
- Base
- Login
- Settings
- Theme
Shop:
- Appointment
- Products
- People
- Internals
- Page
- Contact
If you want to use the project as a Flask base, just remove the shop modules in modules/
The engine
Shopyo's engine which provides a Django-like structure and awesome mechanisms has been abstracted into hadbox
💬 Community: Discord¶
Join the Discord community Discord Group
Docs
Link: abdur-rahmaanj.github.io/shopyo/
- Setting up Shopyo
- Education section
- Contributing to Shopyo
- Modules/Apps
- Templates
- Models
- Views
- Commandline
- Shopyoapi
- Docs
- Unittests
📜 Testimonial
This is my first time contributing to a public repo and I have quite enjoyed it. If you're a
first-time-contributor
the community is very helpful and can help you progress. Since I have been helping in this repo, I have also learnt a few things myself. The owner of the repo is active and is always willing to help.Also, if I'm around and you're stuck give us a shout. I'll help if I can.
@blips5
📖 History
See this linked-in article!
📰 In The News
- Shopyo is announced on LinkedIn
- Featured on Python Weekly issue 436
- Bhavesh Solanki tells about his Open Source experience contributing to Shopyo on LinkedIn
- Arthur Nangai from Andela joins the project as 3rd core committer
- Project goes officially in Beta, v1.0.0 released
- Duckduckgo recognises Shopyo
- Shopyo becomes a trending OpenSource project
Who uses Shopyo?
site name | description |
---|---|
Maurilearn.com | Elearning platform |
TODO modules
- Point of Sales
- Accounting
- Contact [done]
- Pages [in progress]
📞 Contact
Support team if you are stuck
- Abdur-Rahmaan Janhangeer - arj.python@gmail.com
- Nathan -
- Arthur Nangai - arthurnangaiarty@yahoo.co.uk
Roadmap
- ✔️ Models
- ✔️ Migrations
- ✔️ Restful Api
- ✔️ Manage.py
- ✔️ CSRF protection
- ✔️ Easy dev/production mode switch
- ✔️ Login
- ✔️ Api namespacing / apps
- ✔️ Django-like structure (where models, views and templates all in one folder)
- ✔️ Relative reference (.forms for example)
- ✔️ Roles management
- ✔️ Themes
In Progress
- 🔃 Unit tests
- 🔃 Integration tests
- 🔃 Permission levels
🍳 In Action
Supporters
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.