Nourimeals.com / Nourimeals.org

This repo holds the project for our website.

Table of Contents

• Technologoes
• Quick Start
• Running with Docker
• How to work with this repository

Technologoes

• JavaScript
• React

Quick Start

1. Clone the repository

git clone https://github.com/nourimeals/website.git

2. CD into the repository

cd website

3. Install libraries

npm install

3. Run the project

npm run hot

This should open up the website in your browser in http://localhost:8080

The hot script will hot reload whenever you make changes in your files so that you can see your changes right away.

Running with Docker

Running with Docker is an alternative process to run the application.

If you're interested in some of it's advantages and disadvantages, Philipp Hauer's blog has an understandable overview here https://phauer.com/2015/discussing-docker-pros-and-cons/

1. Install Docker

• Open https://docs.docker.com/get-docker/
• Select the OS where you will be installing Docker
• Read the requirements and instructions

2. Create the docker image and container

docker-compose -f docker-compose.yml up -d --build

Command Highlights:

• -f: points to file
• up: Create and start containers
• d: Runs container in background and leaves it running
• --build: Creates the Docker image before starting the container

3. Open http://localhost:8080
4. Occassionally, you should clean up any stopped containers, dangling images, and unused networks

docker system prune

How to work with this repository

• Working with Git: Git Standard Operating Procedures

• Before adding contributions please refer to Front End Best Practices

• Documentation Table of Contents. We use the VS Code [Markdown All in One] (https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) extension.