Pixer React Documentation
WelcomeHow It WorksInstallationVideo TutorialAPIAdmin(REST)ShopAPIAdminShopFeaturesAvailable ScriptsCustomizationStyles and Assets
Back-End Integration
Deployment
New PageFAQSupportVersions

Getting Started & Installation

Video Tutorial

Mac

For getting started with the template you have to follow the below procedure.

API

  1. Go to pixer-api directory and run below command.
# on pixer-api directory
yarn
yarn 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.

  1. Go to admin folder.
  2. Copy the contents of .env.template into a new file called .env
  3. Run below command to start the server.
# on admin directory
yarn dev

Shop

For starting the shop part with corresponding api run below commands.

  1. Go to /shop folder.
  2. Copy the contents of .env.template into a new file called .env
  3. Fill the .env file with your values like, NEXT_PUBLIC_REST_API_ENDPOINT=, NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=, NEXT_PUBLIC_WEBSITE_URL=.
  4. Run below command to start the server.
# on shop directory
yarn 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

  1. Go to /pixer-api folder.
  2. Run yarn build
  3. Run yarn start:prod

Admin

  1. Go to /admin folder.
  2. Run yarn build
  3. Run yarn start

NOTE : API must be running for the above commands to work.

NOTE : .env file must be filled with your values.

Shop

  1. Go to /shop folder.
  2. Run yarn build
  3. Run yarn start

NOTE : API must be running for the above commands to work.

NOTE : .env file must be filled with your values.