Flash deals for restaurants / fast food web app. We dream of helping people discover the hidden gems of their city.

User can go to the web site or mobile app, and see deal happening right now near me. Kai deals should know the cheapest food in your neighbourhood.

Helping restaurant owners to get rid of excess food and avoid waste.

Depending on where you are at in you coding journey you should start here. Below are some quick steps /tutorials to get you familiar with the workflow for contributing to the project.

The end goal is you making a pull request on github.

First lets start by cloning the repo

$ git clone https://github.com/codeforprojects/kaideals.git 

$ cd kaideals

If you are unfamiliar with Git checkout the git section

You will need to have Node and Docker installed to get started.

Now you can Start up the app

If you would like to get involved in the React side of the project please make your first contribution here: React newbie - coming soon

If you choose to follow the node side of the project make sure you check out the

• Express

If are unfamiliar with git start here Git

• open your terminal
• navigate to where you want to download the project to.
• type: git clone https://github.com/codeforprojects/kaideals.git

This will this download the repo locally and turn it into a git repository, which allows to track all the changes you make.

• now you can go ino the project dir
• cd kaideals

Before we start developing we will need to set up a few things

Note on support: were are only able to support Linux and Mac OS natively due to buld system overhead. If you are on Windows skip to vm section

Otherwise for Mac and Linux:

You will need to have a bash command line to run all of the developer tools we use in the project.

To start developing you will need to install docker

Install the relevant version of node js for your operating system here

This will install npm and node.

Run this first to install the npm depedencies used by the project

with everything has been set up.

• open your terminal
• navigate project folder kaideals
• type make install
  • this npm installs all the dependencies for the project
• make start

## To see the running docker containers type:
$ docker ps 

CONTAINER ID        IMAGE               COMMAND                  CREATED             STATUS              PORTS                     NAMES
999f9910cd34        mdillon/postgis     "docker-entrypoint.sh"   37 seconds ago      Up 33 seconds       0.0.0.0:58008->5432/tcp   postgres
726977c0fd05        kaideals_app        "pm2 start processes."   37 seconds ago      Up 34 seconds       0.0.0.0:8000->5000/tcp    app

Our code is running inside of docker containers. You can poke around in the containers with

$ docker exec -it app /bin/sh
/var/www/app # 

you are now inside the tiny operating system of the docker container 'app' being the name of the container you want to explore

• go to http://localhost:8000 in your browser to see the app running

When you have made changes to the code, type make refresh to rebundle the React js code and copy any code changes into the docker containers. This also restarts the Node js process.

Long story short - if makes changes make sure you type make refresh to see them.

To clean up the project environment. This command shuts down the docker containers, removes them and deletes the docker images. as well as uninstalling the npm dependencies.

Handy if your not sure whats going wrong. Burn it all

PS. for more information on these commands checkout the makefile file in the project folder. There you will see what each of the make commands does.

If you are on windows you will need to download this Virtual Machine image - Download

1. first download Virtual box
2. then VM image
3. Finally import the image into Virtual Box and run it - instructions
4. open terminal and start project

$ cd ~/code/kaideals
$ make install
$ make start

So that you dont have to enter your password everytime when you use git, you can add a ssh key. A secure way to identify your computer to github.

github tutorial for creating / adding a ssh key

Managing and tracking project progress:

We are using github projects to manage the project. Go

coming soon....

Code For Projects meetup

Join the slack channel here