-
Notifications
You must be signed in to change notification settings - Fork 0
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
add docker & api route #116
Conversation
PR Review ❌ Documentation drift: Update documentation for port change from 80 to 8080. Generated by Firstmate to make sure you can focus on coding new features. |
ENV PORT 8080 | ||
|
||
WORKDIR /usr/src/app | ||
|
||
RUN addgroup -S appgroup && adduser -S appuser -G appgroup | ||
USER appuser | ||
|
||
RUN apk add --no-cache git | ||
COPY . . | ||
EXPOSE 8080 | ||
CMD ["npm", "start", "--no-update-notifier"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You changed the application to run on port 8080 in the Dockerfile, while the configuration in appConfig.js
now defaults to port 80. This change seems important, so it might be smart to change the documentation accordingly.
For example, update the documentation to reflect the following:
## Running the Application
To start the application, use the following command:
```bash
docker run -p 8080:8080 your-image-name
By default, the application will run on port 80 unless specified otherwise.
router.route("/get/:id").get(exampleController.getById) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The route '/get/:id' is missing the grantAccessByPermissionMiddleware
, which is essential for proper permission checks. Update the route definition to include this middleware as follows:
+ router.route("/get/:id").get(grantAccessByPermissionMiddleware([API_PERMISSIONS.PUBLIC_ENDPOINT]), exampleController.getById)
This ensures that access permissions are validated before executing the controller logic.
(Based on guideline 'Routes should check permissions')
FROM node:19-alpine | ||
ENV PORT 8080 | ||
|
||
WORKDIR /usr/src/app | ||
|
||
RUN addgroup -S appgroup && adduser -S appuser -G appgroup | ||
USER appuser | ||
|
||
RUN apk add --no-cache git | ||
COPY . . | ||
EXPOSE 8080 | ||
CMD ["npm", "start", "--no-update-notifier"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider using multi-stage builds in your Dockerfile to optimize the build process and reduce the final image size. You can achieve this by separating the build and runtime stages like this:
FROM node:19-alpine AS build
WORKDIR /usr/src/app
COPY package*.json ./
RUN npm install
COPY . .
FROM node:19-alpine
WORKDIR /usr/src/app
COPY --from=build /usr/src/app ./
EXPOSE 8080
CMD ["npm", "start", "--no-update-notifier"]
(Based on guideline 'Dockerfiles should use multi-stage builds')
return process.env.PORT || 80; | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ensure that the updated server port environment variable is added to the helm chart values.yaml
file under the configmap section for non-secret variables. This will allow for better configuration management and flexibility in your deployments. Here's an example of how you can add it:
configmap:
serverPort: {{ .Values.serverPort | default "80" }}
(Based on guideline 'Env vars in helm chart values.yaml')
💡 PR Summary generated by FirstMate
Overview: Added Docker support and a new API route for enhanced functionality.
Changes:
Dockerfile creation:
API route updates:
/get/:id
inexampleRouter.js
for fetching data by ID.Configuration change:
appConfig.js
from 8080 to 80 for consistency.TLDR: This PR adds Docker support, a new API route for data retrieval, and updates the default server port. Review the Dockerfile and new route in
exampleRouter.js
.Generated by FirstMate and automatically updated on every commit.