README

This app was created with Rails and Create React App as well as SASS to be responsive and allow a group of friends to be able to plan and organize their by-monthly get togethers.

INSTALLATION

Prerequisites to DEV Mode:

• Ruby v2.7.1
• Rails v6.0.3
• Node v14.4.3
• Nothing Running on specified ports

Prerequisites to Production Mode

• Docker installed. This can be linux native or Windows/MacOS Docker Desktop Community Edition
• Docker Compose installed.
• Nothing running on specified ports

To run this in Dev Mode:

1. go to top level directory and run "yarn dev-install"
2. Make sure Postgres(^12.0) is Running locally and on port 5432(default)
3. If you would like your static files to be served by rails in development run 'yarn build', this will build the required files and copy them to the rails public folder.
4. run "yarn start" - this will start both the Rails development server(localhost:3000) and the React frontend development(localhost:3001) server.
5. shutdown service by either quitting your terminal or hitting "control+c" form the running window.

To Deploy to Web/ Run Locally in Production Mode:

1. go to top level .env_example, copy and rename to .env
2. Enter in your own passwords for a production environment. Just leaving these as default will allow the server to run as a demo.
3. From the top level folder console run "yarn deploy". This will run docker-compose and make this site available at 'localhost' or from your cloud deploy IP address.
   • If you run into errors within this process run each service to trouble shoot errors. you can run each service with:
   • "docker-compose up db"
   • "docker-compose up api"
   • "docker-compose up web"
4. to Shutdown service run "docker-compose down" from another terminal window or hit "control+c" from the running terminal window

Running on Heroku with the Static Site files being served by rails.

Note the slower load times

Running from docker-compose on Google Cloud Compute

This build is running entirely in Docker with nginx serving static site files.

MAJOR GOALS OF THE PROJECT

I wanted to build something that was designed to be fully web and mobile responsive. The focus was to allow a simple portal for friends to coordinate a get together.

I wanted to get to know the process of building and fully deploying a site using docker. Docker is a technology that is taking over or has taken over most sites already. The goal, and I think the success of using tools like docker-compose and nginx(frontend static assets and reverse proxy) has really allowed me to wrap my head around and build with some more complex technologies.

Next Steps

• [] Convert the back end to an express or koa
• [] Add ssl certificates and full https support through nginx

THANK YOU

To Tyler Hansen