specification.html

---
layout: default
title: Specification
---
<h2 class="title">Specification</h2>

<h3>Language</h3>
<p>The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in <a href="https://www.ietf.org/rfc/rfc2119.txt">RFC 2119</a>.</p>

<h3>File location and contents</h3>
<ol>
	<li><code>maker.json</code> MUST reside in the root directory of a project's repository.</li>
	<li><code>maker.json</code> MUST include a single object represented as JSON, with key-value pairs according to the list below.</li>
</ol>
<h3>Fields</h3>
<h4>Required</h4>
<p>The following fields MUST be included:</p>
<ol>
	<li><code>name</code> - a string specifying the project's name.</li>
	<li><code>status</code> - a string (enum) indicating the status of the project. The value MUST be one of:
		<ul>
			<li><code>"Unknown"</code> - No update or recent update provided.</li>
			<li><code>"Active"</code> - The space is open.</li>
			<li><code>"Inactive"</code> - The space is closed</li>
			<li><code>"Planned"</code> - The space is in the planning stages to open.</li>
		</ul>
	</li>
	<li><code>type</code> - An array specifying the type of space. Multiple types are allowed.</li>
	<ul>
		<li><code>"Makerspace"</code> - Your makerspace shop with fabrication tools, computer stations, and community space.</li>
		<li><code>"Fab Lab"</code> - As above, but ONLY those officially affiliated as Fab Labs.</li>
		<li><code>"TechShop"</code> - As above, but ONLY those officially affiliated as TechShops.</li>
		<li><code>"Hackerspace"</code> - A community space more focused on </li>
		<li><code>"Coworking Space"</code> - Open floor plans for startups and small businesses, not necessarily hackers only.</li>
		<li><code>"Innovation Lab"</code> - A space within larger organizations focused on emerging innovations or researching and development practices.</li>
		<li><code>"University Lab"</code> - Sharing many of the principles above but supported by an educational institution and may or may not be only open to students.</li>
		<li><code>"Library"</code> - Libraries as we know them but now offerings access to and workshops about DIY and fabrication topics (i.e. 3D printers).</li>
	</ul>
</ol>


<h4>Recommended</h4>
<p>In addition to the above fields, the following fields SHOULD be included in every maker.json, where applicable:</p>
<ol>
	<li><code>source</code> - The source of this information. This could be a website, person, email address, or media source.</li>
	<li><code>description</code> - A brief summary of the location and/or community. A good description should not reiterate other parts of the schema such as available tools or location but offer details on the mission, vision, history, and values.</li>
	<li><code>address</code> - A string specifying the physical address of the location. This information SHOULD only include the street address or relative structures/business if that's not available. It SHOULD NOT other administrative information (to include separately, see below).</li>
	<li><code>city</code> - The city in which the space is located.</li>
	<li><code>division</code> - The state, province, district, or boundary in which the space is located.</li>
	<li><code>country</code> - The country in which the space is located.</li>
	<li><code>latitude</code> - A decimal of the exact latitude of the space.</li>
	<li><code>longitude</code> - A decimal of the exact longitude of the space. </li>
	<li><code>website</code> - The official website of the space, if available.</li>
	<li><code>phone</code> - The official phone number for the space, if available.</li>
	<li><code>mailing-list</code> - The address of a mailing list, if available.</li>
	<li><code>email</code> - A contact email for the space, if available.</li>
	<li><code>social</code> - An array of the social media accounts associated with the space.</li>
	<li><code>tools</code> - An array of the available tools within the space. This is geared more toward the makerspaces.</li>
</ol>

<h4>Other</h4>
<p>You MAY want to include other fields not listed above.</p>
<ol>
	<li><code>number-of-members</code> - The average or estimated number of members in the space.</li>
	<li><code>membership-fee</code> - A string explaining any membership costs and frequency.</li>
	<li><code>open-to-exchanges</code> - A boolean for if the space is open to exchanging tools.</li>
	<li><code>open-to-residences</code> - A boolean for if the space offers residencies.</li>
	<li><code>size-of-rooms</code> - The average or estimated size of the rooms.</li>
</ol>