Overview

This document is a quick starting point for this project that contains must-read information. At the end of this document you'll find a document index that will link you to further information.

Project Goal

The goal of this project is to create a good agile project management tool that adheres as closely to scrum best practices as possible.

Getting Started (for Contributors)

See Contributing Guide for detais.

Document Index

End Users

User Guide - An entrypoint for end users of Atoll.

Contributor Related

Code Standards - Read this!
Conventions - Important naming conventions information.
Architecture - Architecture related info
Code Architecture - Code-level architecture related info
Dev HowTo - Contains details for how to implement things.
Dependencies - Detailed information about the npm packages used.
Scripts - Detailed information about the build & npm scripts.
History - The past history of this project.
Policies - Github branch policies etc.
Glossary - Glossary specific to this project.
Troubleshooting - This may be useful if you're running into problems.
Data Model - Mapping the requirements to the data model.
Process - The index document for processes that should be followed.

Github Wiki