Giter VIP home page Giter VIP logo

hackathon-orange-iguanas's Introduction

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

hackathon-orange-iguanas's People

Contributors

aclaire-thd avatar alex-hall avatar bhargavmuddaluru avatar dsmule avatar mitchgianoni avatar raven11 avatar wrmilling avatar xploreout avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.