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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Feature: Mention the .env file in Local Development documentation #41

Closed
2 tasks done
Deadreyo opened this issue Oct 3, 2022 · 2 comments 路 Fixed by #42
Closed
2 tasks done

Feature: Mention the .env file in Local Development documentation #41

Deadreyo opened this issue Oct 3, 2022 · 2 comments 路 Fixed by #42
Assignees
@Deadreyo
Labels
馃挕 feature A label to note if work is a feature 馃憖 needs triage released on @beta released

Comments

@Deadreyo
Copy link
Contributor

Deadreyo commented Oct 3, 2022

Type of feature

馃摑 Documentation

Current behavior

Right now there's no mention of having to create a .env file when installing and running the repo. This leads to the server not being able to run, and can get confusing as to why it is not running for new contributors.

Also in the .env file, for windows users it should be mentioned that the API_HOST key should be equal to 127.0.0.1, as opposed to 0.0.0.0

Suggested solution

Mentioning it is required and adding that windows info to the readme file under the Local Development section.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs
@Deadreyo Deadreyo added 馃憖 needs triage 馃挕 feature A label to note if work is a feature labels Oct 3, 2022
@Deadreyo Deadreyo changed the title Feature: Mention the .env file in getting started documentation Feature: Mention the .env file in Local Development documentation Oct 3, 2022
@Deadreyo Deadreyo self-assigned this Oct 3, 2022
@Deadreyo Deadreyo mentioned this issue Oct 3, 2022
Merged
19 tasks
github-actions bot pushed a commit that referenced this issue Oct 3, 2022
@Deadreyo @open-sauced
chore(minor): release 1.14.0-beta.1 on beta channel [skip ci]
583b2da 
## [1.14.0-beta.1](v1.13.0...v1.14.0-beta.1) (2022-10-03)

### 馃摑 Documentation

* mentioned .env file ([#42](#42)) ([a17b835](a17b835)), closes [#41](#41)
@github-actions
Copy link

github-actions bot commented Oct 3, 2022

馃帀 This issue has been resolved in version 1.14.0-beta.1 馃帀

The release is available on:

Your semantic-release bot 馃摝馃殌

github-actions bot pushed a commit that referenced this issue Oct 3, 2022
@0-vortex
docs: mentioned .env file (#42)
208be49 
closes #41 a17b835
github-actions bot pushed a commit that referenced this issue Oct 4, 2022
@0-vortex @open-sauced
chore(minor): release 1.14.0 [skip ci]
219f8a5 
## [1.14.0](v1.13.0...v1.14.0) (2022-10-04)

### 馃摑 Documentation

* mentioned .env file ([#42](#42)) ([a17b835](a17b835)), closes [#41](#41)

### 馃悰 Bug Fixes

* increase paginated response limit to 500 ([b174a3f](b174a3f)), closes [#43](#43)
@github-actions
Copy link

github-actions bot commented Oct 4, 2022

馃帀 This issue has been resolved in version 1.14.0 馃帀

The release is available on:

Your semantic-release bot 馃摝馃殌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Deadreyo Deadreyo

Labels
馃挕 feature A label to note if work is a feature 馃憖 needs triage released on @beta released
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: mentioned .env file Deadreyo/api.opensauced.pizza
1 participant
@Deadreyo