Skip to content

Commit 307304e

Browse files
committed
Update README file
1 parent 68be400 commit 307304e

File tree

4 files changed

+83
-25
lines changed

4 files changed

+83
-25
lines changed

.idea/vcs.xml

+6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/workspace.xml

+43-25
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# PyShop
2+
3+
PyShop is an online Python Ecommerce website built with Django, SQLite and Bootstrap. A simple and lightweight ecommerce app easily deployable anywhere anytime with modules developed upon the inbuilt django admin.
4+
5+
<p align="center"><img src="/pyshop-app.png"></p>
6+
7+
8+
# Get Started
9+
To setup the PyShop project, here is the following guidelines:
10+
* Clone the repository <code>git clone https://github.com/thisishaykins/PyShop.git</code>
11+
* Open Project folder on terminal
12+
* Create migrations using <code>python3 manage.py makemigrations</code>
13+
* Run migrations <code>python3 manage.py migrate</code>
14+
* Start your dev server with <code>python3 manage.py runserver</code>
15+
* Visit your App using <code>http://127.0.0.1:8000/</code>
16+
* Create super user to access admin dashboard using <code> python3 manage.py createsuperuser</code>
17+
* Follow the prompts after <code>Username: , Email address: , Password: , Password (again): </code>
18+
* Visit Admin Page using <code>http://127.0.0.1:8000/admin</code> and login with the credentials created above.
19+
* Add Products under the <b>Products</b> Menu, Add Offers also.
20+
* Visit Products Page using <code>http://127.0.0.1:8000/products/</code>
21+
* Visit New Arrival (Products) Page using <code>http://127.0.0.1:8000/products/new</code>
22+
* Wish codebase to extend code? just say hi
23+
24+
25+
## Contributing
26+
Thank you for considering contributing to this small python project! For contribution discuss, please email to Akinshola Samuel [akinsholasamuel@gmail.com](mailto:akinsholasamuel@gmail.com).
27+
28+
29+
## Security Vulnerabilities
30+
If you discover a vulnerability or bugs within this project, please send an e-mail to Akinshola Samuel via [akinsholasamuel@gmail.com](mailto:akinsholasamuel@gmail.com). All bugs and vulnerabilities will be promptly addressed.
31+
32+
33+
## License
34+
The PyShop Project is free open-sourced project, yet to be licensed under the [MIT license](https://opensource.org/licenses/MIT).

pyshop-app.png

1.7 MB
Loading

0 commit comments

Comments
 (0)