Skip to main content

Run gs-project

To run a project you should be either in the client or server directory of your project, depending on which plugin you need to run.

Steps for running basic init project is defined here. Each plugin has a guide on how to run the project with that plugin added.

Steps for running Server Plugin​

  1. Navigate to your project directory: cd 'project-name'
  2. Go to the server directory: cd server
  3. Install npm dependencies: npm install
  4. Create a .env file and copy & paste the .env.example file: cp .env.example .env
  5. Start the development server: npm run start:dev
  6. Access GraphQL at: http://localhost:3000/graphql
  7. Access Swagger at: http://localhost:3000/api

Steps for running Client Plugin​

  1. Navigate to your project directory: cd 'project-name'
  2. Go to the client directory: cd client
  3. Install npm dependencies: npm install or yarn install
  4. Create a .env file and copy & paste the .env.example file: cp .env.example .env.development
  5. Start the development server: npm run start or yarn start
  6. Access application on web at: http://localhost:8081
  7. You can also access the application in simulator or emulator.