CCP555 - this developing project uses Node.js and express module to host an API Server along with AWS Cognito, at this time it takes requests from /GET /POST.
npm i
- installs necessary dependencies for running locally
npm start
- to start running the server at node src/index.js
npm run lint
- runs check on coding style and problems
When the server started successfully on localhost:8080
with an health check and the logger message should show that Server started
and Cognito JWKS cached
.
npm run dev
- run the server in development mode
npm run debug
- runs the server in debug mode
nodemon
is configured and will keep monitorning for code changes and restarting the server.
prettier
setup in .prettierrc
eslint
setup in .eslintrc.js
run npm run lint
to detect formatting issues.
Hadolint
used for this project to format the Dockerfile.
Run Hadolint Dockerfile
to format the Dockerfile.
This project is dockerized, image resides in Dockerhub: LostButton/fragments
OR simply run
docker pull LostButton/fragments:latest
This is the current list of valid conversions for each fragment type (others may be added in the future):
Type | Valid Conversion Extensions |
---|---|
text/plain |
.txt |
text/markdown |
.md , .html , .txt |
text/html |
.html , .txt |
application/json |
.json , .txt |
image/png |
.png , .jpg , .webp , gif |
image/jpeg |
.png , .jpg , .webp , gif |
image/webp |
.png , .jpg , .webp , gif |
image/gif |
.png , .jpg , .webp , gif |