homedepot / hackathon-starter

Hackathon starter repository which provides a baseline react/node/mongo app with integrations

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

hackathon-starter

create-react-app + expressjs + mongodb + docker-compose!!

Node.JS Version Code Coverage Build Status License

Quick Setup

This starter application uses docker-compose to get the entire environment setup off of the ground.

The tech stack is:

If you don't have docker installed, install docker desktop.

From there, clone the repository into your workspace of choice.

Finally, make sure you are on public wifi and then run the following command from your favorite terminal:

docker-compose down && docker-compose build && docker-compose up

NOTE: The first build will be slow due to docker world-building

This will host your front end on localhost:3001, your api endpoint on localhost:3002, and mongodb will be networked internally (more details TBD). You can connect a remote debugger to 0.0.0.0:56745 in order to debug the api.

The frontend and backend will auto-refresh as you make changes, and the only time you will ever need to re-run docker-compose down && docker-compose build && docker-compose up is if you made changes to the package.json file in either ui or api.

TODOs

About

Hackathon starter repository which provides a baseline react/node/mongo app with integrations

License:Apache License 2.0


Languages

Language:JavaScript 89.0%Language:HTML 6.4%Language:CSS 3.0%Language:Dockerfile 1.3%Language:Shell 0.4%