Skip to content

Commit

Permalink
chore: minor doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
sebinbenjamin committed Aug 16, 2024
1 parent 84065f2 commit f503c3c
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ MYSQL_HOST=123.456.789.0
MYSQL_USER=mydbAdmin
MYSQL_PASSWORD=mydbAdminPassword
MYSQL_DATABASE=world
PORT=4000
NODE_APP_PORT=4000
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
DigiCertGlobalRootCA.crt.pem
.env
node_modules
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Follow these steps to set up the project on your local machine:
### Using `.env` and `.env.example` Files

- **`.env` File:**
The `.env` file is used to store environment-specific configurations such as database credentials, API keys, and other sensitive information. It should never be committed to the version control system (e.g., Git) for security reasons. Make sure to add `.env` to your `.gitignore` file.
The `.env` file is used to store environment-specific configurations such as database credentials, API keys, and other sensitive information. It should **never** be committed to the version control system (e.g., Git) for security reasons. Make sure to add `.env` to your `.gitignore` file.

- **`.env.example` File:**
The `.env.example` file is a template version of the `.env` file. It should contain placeholders for all the environment variables used in the project but without actual sensitive values. This file can be safely committed to your repository and shared with your team to provide guidance on the required environment variables.
Expand Down
2 changes: 1 addition & 1 deletion server.js
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ app.get("/population/:continent", (req, res) => {
To receive the requests, your app should listen to that port using process.env.PORT.
*/
const PORT = process.env.PORT || 4000;
const PORT = process.env.NODE_APP_PORT || 4000;

app.listen(PORT, () => {
console.log(`Server is live at http://localhost:${PORT}`);
Expand Down

0 comments on commit f503c3c

Please sign in to comment.