Creating Your Project

The first step to configuring your project, is to create your project directory and files and input information about your project.

Create your project directory and files

1. In the project/ directory, create a new folder with your project name, e.g. my_project

2. This new folder should have the following file structure:

   my_project/
   +-- content/
   |   +-- help/
   +-- assets/
   |  +-- css/
   |  +-- images/
   |  +-- javascript/
   +-- subjects/
   +-- tutorial/
   +-- workflows/
   +-- project.json
   

3. Take a look at example files in the project directories: anzac, emigrant, or whale_tales. You can even copy one of these projects, then add/remove/modify the files as necessary

We will go into more detail about what goes into these files and folders in the next steps.

Enter Project Details

Create a file project.json in your project directory like so:

my_project/
+-- assets/
|  +-- images/
|     +-- logo.svg
|     +-- background.jpg
+-- project.json

And fill in the following JSON

{
  "title": "My Project: The One About Cats",
  "short_title": "My Project",
  "summary": "We want to see if (yes obviously) cats are better than animals",
  "logo": "/images/logo.svg",
  "background": "/images/background.jpg",
  "admin_email": "[email protected]",
  "team_emails": [
    "[email protected]",
    "[email protected]"
  ],

  "team": [
    {
      "name": "Simba",
      "role": "Lion",
      "image": "http://placekitten.com/200/300",
      "organization": "businesscat"
    },
    {
      "name": "Butch Catsidy",
      "role": "Cat",
      "image": "http://placekitten.com/200/300",
      "organization": "businesscat"
    }
  ],

  "organizations": [
    {
     "title": "Business Cat",
     "description": "Deficit? You've got to be kitten me",
     "url":"http://businesscat.org",
     "logo": "http://businesscat.org/logo.png"
    }
  ],

  "forum": {
    "type": "discourse",
    "base_url": "http://catchat.biz"
  }

}

Create pages with supporting content

Your can create any number of supporting pages that will appear as links in the top navigation of the project website. Simply add them to the content folder of your project directory

my_project/
+-- content/
|   +-- about.html.erb
|   +-- home.html.erb
|   +-- team.html.erb

The pages support html and markdown syntax.

---

Next step: Create your project workflows