Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update Docs to Reflect Change to .env.example #3561

Merged
merged 4 commits into from
Oct 17, 2019

Conversation

theaquarium
Copy link
Contributor

@theaquarium theaquarium commented Oct 16, 2019

Fixes #3560

Short description of what this resolves:

Updates the documentation to reflect the change to the default .env.example file which now points to Heroku and not localhost.

Changes proposed in this pull request:

  • Update Local.md doc to reflect changes to default config

Checklist

  • I have read the Contribution & Best practices Guide.
  • My branch is up-to-date with the Upstream development branch.
  • The acceptance, integration, unit tests and linter pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

@@ -34,7 +34,7 @@ brew reinstall gettext
brew link --force gettext
```

- By default, the `.env.example` file specifies the `API_HOST` as `localhost:5000` and assumes, that the [open-event-server](https://github.com/fossasia/open-event-server) is already up and running. If you intend to work on issues which involve both the frontend, and the backend, please install and set it up first before proceeding to run the frontend. **If however, you intend to work on just the frontend, please change the URL for `API_HOST` to `https://open-event-api-dev.herokuapp.com` which is a test deployment of the open-event-server.**
- By default, the `.env.example` file specifies the `API_HOST` as `https://open-event-api-dev.herokuapp.com` which is a test deployment of the open-event-server. If you intend to work on just the frontend, this is sufficient. **If however, you intend to work on issues which involve both the frontend and the backend, you must have the [open-event-server](https://github.com/fossasia/open-event-server) already up and running. Please install and set it up first before changing the URL for `API_HOST` to `localhost:5000` and proceeding to run the frontent.**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the typo in last line

@kushthedude
Copy link
Member

Please use the Semantic PR Naming for naming your PR's

@theaquarium theaquarium changed the title Update Docs to Reflect Change to .env.example fix: Update Docs to Reflect Change to .env.example Oct 16, 2019
@auto-label auto-label bot added the fix label Oct 16, 2019
@theaquarium
Copy link
Contributor Author

Sorry about that. Should be fixed.

@iamareebjamal iamareebjamal changed the title fix: Update Docs to Reflect Change to .env.example docs: Update Docs to Reflect Change to .env.example Oct 17, 2019
@auto-label auto-label bot removed the fix label Oct 17, 2019
@iamareebjamal iamareebjamal merged commit 862d7f2 into fossasia:development Oct 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

readME: Update ReadME for local installation as there is change in .env
3 participants