Skip to content

Commit 4ab992d

Browse files
krubenoksrandall97
authored andcommitted
Add Docker Support (#27)
* add docker support * package-lock.json changed? * add documentation for deployment * WIP. Add docker compose and new dockerfile The application launches but it can't connect to the mongoDB started in docker. WIP. * did final on package-lock before merge * Back to a standard docker file * Simplify * Add gulp buidl * correct executable path for gulp and use slim node image * Create rebase.yml * nevermind * conform to eslint standards * revert eslint changes
1 parent de635cc commit 4ab992d

File tree

4 files changed

+50
-12
lines changed

4 files changed

+50
-12
lines changed

.dockerignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
node_modules/
2+
app/client/build/
3+
app/client/plugins/
4+
*.log
5+
.env

Dockerfile

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
FROM node:10.17.0-buster-slim
2+
3+
WORKDIR /usr/app/src
4+
EXPOSE 3000
5+
6+
# Load Source
7+
COPY . .
8+
9+
# Install node_modules
10+
RUN npm install
11+
RUN ./node_modules/.bin/gulp build
12+
13+
CMD node app.js

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,10 @@ Edit the configuration file in `.env` for your setup, and then run the applicati
157157
```bash
158158
gulp server
159159
```
160+
### Deploying for your hackathon
161+
The database can either be hosted with [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) or on your own server. Atlas will generally be easier to set up and should be the preferred choice unless you are familiar with administering your own server. A guide to setting up Atlas can be found [here](https://docs.atlas.mongodb.com/getting-started/). Note that the URI for the database (which must be specified in `.env`) will be different depending on where your database is hosted.
162+
163+
There are also several options for hosting Quill itself. You can use Heroku by clicking the __Deploy to Heroku__ button above where, after making a Heroku account, you will be able to set the configuration variables and deploy Quill. A Dockerfile has also been provided to make it easy to run Quill in a Docker container either on your own server or with your preferred cloud service provider. Don't forget to publish the container's port `3000` to the host machine. If using the command line, this is done by using the `-p` flag and specifying which port on the host machine should redirect to port 3000 on the container.
160164

161165
## Customizing for your event
162166

package-lock.json

+28-12
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)