Skip to content

ramkrishn123/hackathon-orange-iguanas

 
 

Repository files navigation

hackathon-orange-iguanas

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

Node.JS Version Code Coverage Build Status License

Quick Setup

This orange-iguanas 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)

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.

Swagger UI

This api project is configured with Swagger-ui documentation tool, you can access the swagger-ui by hitting below endpoint

http://localhost:3002/api-docs/

TODOs

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 89.5%
  • CSS 6.9%
  • HTML 2.8%
  • Other 0.8%