Skip to content

Commit

Permalink
Add Docker Support (hackohio#27)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
krubenok authored and srandall97 committed Nov 22, 2019
1 parent de635cc commit 4ab992d
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 12 deletions.
5 changes: 5 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
node_modules/
app/client/build/
app/client/plugins/
*.log
.env
13 changes: 13 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
FROM node:10.17.0-buster-slim

WORKDIR /usr/app/src
EXPOSE 3000

# Load Source
COPY . .

# Install node_modules
RUN npm install
RUN ./node_modules/.bin/gulp build

CMD node app.js
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,10 @@ Edit the configuration file in `.env` for your setup, and then run the applicati
```bash
gulp server
```
### Deploying for your hackathon
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.

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.

## Customizing for your event

Expand Down
40 changes: 28 additions & 12 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4ab992d

Please sign in to comment.