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

Update README.md #114

Merged
merged 1 commit into from
Feb 7, 2022
Merged

Update README.md #114

merged 1 commit into from
Feb 7, 2022

Conversation

apoorv-mishra
Copy link
Contributor

Pull Request Template

Description

Adds instruction for setting APP_BASE_URL in .env on local.

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

Checklist:

  • I have manually tested all workflows
  • I have performed a self-review of my own code
  • I have added automated tests for my code

@vipulnsward vipulnsward temporarily deployed to miru-review-pr-114 February 7, 2022 05:57 Inactive
@vipulnsward vipulnsward temporarily deployed to miru-review-pr-114 February 7, 2022 06:00 Inactive
@github-actions
Copy link

github-actions bot commented Feb 7, 2022

Current Code Coverage Percent of this PR:

70.58 %

Files having coverage below 100%

Impacted Files Coverage
/config/application.rb 92.86 %
/config/routes.rb 94.74 %
/app/models/user.rb 83.33 %
/app/controllers/projects_controller.rb 50.0 %
/app/controllers/application_controller.rb 66.67 %
/app/helpers/application_helper.rb 40.0 %
/app/helpers/team_helper.rb 57.14 %
/app/helpers/users/registrations_helper.rb 41.67 %
/app/controllers/company_controller.rb 36.67 %
/app/controllers/root_controller.rb 33.33 %
/app/controllers/team_controller.rb 83.33 %
/app/controllers/users/passwords_controller.rb 41.67 %
/app/controllers/users/omniauth_callbacks_controller.rb 25.0 %
/app/controllers/users/sessions_controller.rb 25.0 %
/app/controllers/users/registrations_controller.rb 45.83 %
/app/controllers/users/invitations_controller.rb 63.64 %
/app/controllers/internal_api/v1/application_controller.rb 80.0 %
/app/controllers/internal_api/v1/clients_controller.rb 66.67 %

10. Run `bin/rails db:create RAILS_ENV=development` to create the database
11. Run `bin/rails db:migrate RAILS_ENV=development` for migrations
12. Run app in local env
10. Update `APP_BASE_URL` in `.env` to `localhost:3000`
Copy link
Member

Choose a reason for hiding this comment

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

can you change this to some generic context. Because they need to update other env's as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is for development. In fact, all instructions above are for development. What context do we need to set?

Copy link
Member

Choose a reason for hiding this comment

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

You can say it generally, like

Update environment variables in .env

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was specifically for APP_BASE_URL which new devs get tricked on after confirming the email for first time registration since it redirects to the wrong URL if this env var is not correctly set(like what happened with @SiddharthShringi as discussed in standup the other day, happened with me too for the first time).

Copy link
Member

Choose a reason for hiding this comment

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

okay

Copy link
Member

@akhilgkrishnan akhilgkrishnan left a comment

Choose a reason for hiding this comment

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

LGTM 🎉

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.

3 participants