efir-tractatus / sdc-questions-answers

A simple GraphQL API to serve data to a Q&A component of a front-end retail portal

Hi there 👋

sdc-questions-answers's Issues

Pem Key Location

https://github.com/efir-tractatus/Questions-Answers/blob/f8c211b3e4c9f113a22cee1127ea297c04d89eb4/.gitignore#L3

Good job ignoring any .pem keys in your .gitignore and .dockerignore. However, just to be extra careful and follow best convention, I believe you're supposed to keep any .pem files/keys inside the 'ssh' directory located in your root directory (on Macs found at ~/.ssh), to avoid them getting accidentally pushed up to GitHub or become publicly available.

Volume for Server Code (?)

https://github.com/efir-tractatus/Questions-Answers/blob/f8c211b3e4c9f113a22cee1127ea297c04d89eb4/docker-compose-dev.yml#L4-L15

I would suggest possibly also attaching a volume to your server code in case you want to make changes on your local machine and have them automatically update in your Docker container. If you create this container and use 'nodemon', you can make changes and simultaneously see them made in your container as you code!

Location of Server Dockerfile

https://github.com/efir-tractatus/Questions-Answers/blob/f8c211b3e4c9f113a22cee1127ea297c04d89eb4/Dockerfile#L1-L13

It might make more sense to have the Dockerfile to build your 'server' image inside the actual 'server' directory so you don't need to have longer paths in the Dockerfile itself and you can just specify the path to your 'server' directory from the docker-compose yaml files

Placement of Hosts/Ports

https://github.com/efir-tractatus/Questions-Answers/blob/f8c211b3e4c9f113a22cee1127ea297c04d89eb4/src/db/index.js#L2-L4

Usually it's best practice to keep IP's and Ports in a 'config' file or as environment variables. Here, it doesn't really matter because it's on your localhost, but if you possibly switch it to a public host, you may not want to make that public on GitHub.

Update README file

Make sure to create a Readme file to outline how to get the project up and running, and key information you want to convey about it. This is the first page that will show when anyone researches your repository, so make it welcoming. Feel free to outline your efforts and reference materials demonstrating your work on the project, and remember to include instructions on how to use those npm scripts.

Your code should be readable, but it can’t speak for itself. Provide context for the project and use the README to tell the reader what they need to know about this project. For SDC, this is your chance to outline considerations that don’t appear in code. Check out the learn for more.