Storeo is an open-source ecommerce framework that allows developers to effortlessly setup an online store. It's built around clear design principles that make it modular, extendible, and easy to get up and running.
This repo is the back-end of the app, you can find the front-end here.
-
Make sure that you have a SQL database installed. (MySQL or PostgreSQL recommended)
-
After installation of SQL database follow respective db guide to start DB.
For MySQL type:
$ sudo mysql.server startOr
$ mysql -u <user> -pThe first command will prompt you to enter your computer's password.
If you use the second command <user> is the user name of the DB, by default it is root and the default password is admin. Be sure to change them.
- If the previous commands successfully run, now you are logged into your local database.
You should see a command line prompt like the following (for MySQL):
mysql>and for PostgreSQL:psql> - In the command line prompt type
$ CREATE DATABASE <nameofdatabase>where<nameofdatabase>is the name of the database the Storeo server will be connecting to.
$ npm installfor dependencies- Follow the
'.env.example'file to create your own '.env' file. $ npm startto launch the server. The npm start script will automatically use Babel to transpile the code and start the server on default port 3000. Babel is being used we adopted the ES6 import syntax that is not yet supported by Node.npm run populatewill generate mock data in the database so that you can start testing how the API works right away.- An exhaustive Postman collection has been added for your convenience inside the
postmanfolder of the repository.
Find a diagram of the database structure here
- Christian Francia - ctfrancia - Linkedin
- Luca Panzavolta - LucaPanzavolta - Linkedin
- Uros C - ross-u - Linkedin
- Tomasz Gasienica - Casprovy - Linkedin
- Zain Sayed - zain-ali-syed - Linkedin
As this is a 100% open source project all contributions and pull requests will be highly welcomed!