begin adding instructions to readme

Author: Xavier Medrano

README.md

@@ -1,58 +1,56 @@
-# Code Challenge v2
+# DataMade Code Challenge:  React Map
 
-_A shiny new Django project!_
+---
 
-## Development
+Welcome to the DataMade code challenge! 👋
 
-### Setup
+## Contents
+1. [Overview](#overview)
+2. [Installation](#installation)
+3. [Completing the Challenge](#completing-the-challenge)
+  a. [TODO:](#step-1-todo)
 
-#### Docker
+## Overview
+Your task is to complete the following programming exercise to show us some of your code! This exercise is based on work that DataMade does every day: pulling data from the web, debugging tricky code, and presenting information to the world.
 
-Development requires a local installation of [Docker](https://docs.docker.com/install/)
-and [Docker Compose](https://docs.docker.com/compose/install/).
+Submissions should be submitted as a pull request against your fork of this original repository. **Make sure to make your pull request against your own fork of the repository, not the original DataMade repository**.
 
-#### Pre-commit
+There’s no time limit, but don’t feel the need to go over the top with your submission. We expect this task to take about two hours to complete, but it could take more or less time depending on your familiarity with Django and JavaScript. When you’re all set, share your code with us as a repository on GitHub.
 
-Pre-commit hooks are scripts that run on your local machine before every commit.
+We’ll be evaluating whether the code works, as well as its quality. Before submitting, make sure that your code does what you expect it to do, that it’s clean and neat enough to meet your standards, and that you’ve provided us some instructions on how to run it. Be warned: there are some intentional bugs in here that you'll have to iron out to get things working!
 
-We use the [pre-commit](https://pre-commit.com/) framework to run code linters and formatters that keep our codebase clean.
+*Note: If you would prefer to keep your code challenge private, please share access with the following members of DataMade on GitHub:*
 
-To set up Pre-Commit, install the Python package on your local machine using:
+| Member      | GitHub Account                   |
+| ----------- | -------------------------------- |
+| Hannah      | https://github.com/hancush       |
+| Derek       | https://github.com/derekeder     |
+| Monkruman   | https://github.com/antidipyramid |
+| Xavier      | https://github.com/xmedr         |
+| Hayley      | https://github.com/haowens       |
 
-```bash
-python -m pip install pre-commit
-```
-
-If you'd rather not install pre-commit globally, create and activate a [virtual environment](https://docs.python.org/3/library/venv.html) in this repo before running the above command.
+Keep in mind that you cannot create a private fork of a public repository on GitHub, so you’ll need to [follow these instructions](https://gist.github.com/0xjac/85097472043b697ab57ba1b1c7530274) to create a private copy of the repo.
 
-Then, run:
 
-```bash
-pre-commit install
-```
+## Installation
+Development requires a local installation of [Docker](https://docs.docker.com/get-started/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/). These are the only two system-level dependencies you should need.
 
-Since hooks are run locally, you can modify which scripts are run before each commit by modifying `.pre-commit-config.yaml`.
-
-### Usage
-
-#### Running the app
+Once you have Docker and Docker Compose installed, build the application containers:
 
 ```bash
-docker compose up
+docker compose build
 ```
 
-#### Running the tests
+Next, run the app:
 
 ```bash
-docker compose -f docker-compose.yml -f tests/docker-compose.yml run --rm app
+docker compose up
 ```
 
-#### Managing site styles
+The app will log to the console, and you should be able to visit it at http://localhost:8000
 
-We use the Bootstrap Node package to build a custom version of Bootstrap for our use. To
-make changes to Bootstrap defaults (colors, layout, etc.), update the included Sass file
-at `map/static/scss/map.scss`. Changes
-to this file will automatically be applied during local development.
+## Completing the Challenge
+Once you have the app up and running on your computer, you'll need to flesh out certain code blocks to make the map functional.
 
-To add styles unrelated to Bootstrap, e.g., customizing a map or some other novel element,
-update the included CSS file at `map/static/css/map.css`.
+### Step 1: TODO:
+TODO:

map/templates/map/home_page.html

@@ -6,7 +6,7 @@
   <div class="container-fluid">
     <div class="row">
       <div class="col-sm-10 offset-sm-1">
-        <h1>Welcome to the website!</h1>
+        <h1>Welcome to the challenge!</h1>
       </div>
     </div>
     <div class="row">