otasoft-core icon indicating copy to clipboard operation
otasoft-core copied to clipboard

Some corrections to README file

Open teresakozera opened this issue 4 years ago • 0 comments

Bug Report

Current behavior

Input Code

Expected behavior

  1. It is good to remember to generate publickey first: https://docs.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
  2. REMEMBER to run docker daemon: sudo systemctl enable docker AND sudo systemctl start docker
  3. clone all the repositories from otasoft-core: 'git clone --recurse-submodules [email protected]:otasoft/otasoft-core.git'
  4. cd otasoft-core
  5. cd scripts and THEN sh install.sh (if node version is too old there may appear issues at this stage)
  6. in otasoft-core and also in other repos, for example api-gateway/otasoft-api: 'cp .env.example .env' -> maybe it would be good to provide a properly filled .env file?
  7. In .env: instead of 'production' - 'development'
  8. Generate certificates: in api-gateway/otasoft-api execute: sh scripts/generate-ssl-cert.sh
  9. In /etc/hosts add: 'localhost api.otasoft.org'
  10. For Linux: in api-gateway/otasoft-api/nginx/dev/nginx.conf comment option for Mac and add: 'server localhost:3000; # Device localhost inside Docker for Linux'
  11. 'docker-compose up --build' should be called for a particular project, for example otasoft-api (api-gateway/otasoft-api), not from otasoft-core. After 'Resetting node maintenance status' is displayed you can proceed to yarn command -> DO NOT CLOSE THE WINDOW
  12. Open another terminal window, in the project, for example otasoft-core-api-gateway-otasoft-api, execute 'yarn start:dev'
  13. You can verify whether everything is working properly by using POSTMAN or entering in your browser 'http://localhost:3000/api/health' (you should see: 'API Gateway is working correctly') or 'http://localhost:3000/graphql', then when 'Warning: Potential Security Risk Ahead' is displayed do: 'Advanced...->Accept the Risk and Continue'

Possible Solution

Environment

teresakozera avatar Feb 07 '21 15:02 teresakozera