WelcomeHow It WorksInstallationVideo TutorialAPIAdmin(REST)ShopAPIAdminShopFeaturesAvailable ScriptsCustomizationStyles and AssetsNew PageFAQSupportVersions
Back-End Integration
Deployment
Getting Started & Installation
Video Tutorial
Mac
For getting started with the template you have to follow the below procedure.
API
- Go to
pixer-api
directory and run below command.
# on pixer-api directoryyarnyarn start:dev
NOTE : This will start the server at http://localhost:5000/api/
for rest api and you can access it from browser at http://localhost:5000/docs
(for rest swagger doc).
Admin(REST)
For starting the admin dashboard part with corresponding api data run below commands.
- Go to
admin
folder. - Copy the contents of
.env.template
into a new file called.env
- Run below command to start the server.
# on admin directoryyarn dev
Shop
For starting the shop part with corresponding api run below commands.
- Go to
/shop
folder. - Copy the contents of
.env.template
into a new file called.env
- Fill the
.env
file with your values like,NEXT_PUBLIC_REST_API_ENDPOINT=, NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=, NEXT_PUBLIC_WEBSITE_URL=
. - Run below command to start the server.
# on shop directoryyarn dev
NOTE : API must be running for the above commands to work.
NOTE : .env
file must be filled with your values.
If you want to test your production build admin or shop in local environment then run the below commands.
API
- Go to
/pixer-api
folder. - Run
yarn build
- Run
yarn start:prod
Admin
- Go to
/admin
folder. - Run
yarn build
- Run
yarn start
NOTE : API must be running for the above commands to work.
NOTE : .env
file must be filled with your values.
Shop
- Go to
/shop
folder. - Run
yarn build
- Run
yarn start
NOTE : API must be running for the above commands to work.
NOTE : .env
file must be filled with your values.