Lara Cook

190218

IDV304

Nimble

Where drawing meets learning
Explore the docs »

View Demo · Report Bug · Request Feature

## Table of Contents

• About the Project
  • Project Description
  • Built With
• Getting Started
  • Prerequisites
  • How to install
• Features and Functionality
• Concept Process
  • Ideation
  • Wireframes
  • User-flow
• Development Process
  • Implementation Process
    • Highlights
    • Challenges
  • Reviews and Testing
    • Feedback from Reviews
    • Unit Tests
  • Future Implementation
• Final Outcome
  • Mockups
  • Video Demonstration
• Conclusion
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About the Project

Project Description

A nice introduction to this amazing project of mine.

Built With

• Technology Name
• Technology Name
• Technology Name

Getting Started

The following instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Ensure that you have the latest version of Software installed on your machine. The Plugin plugin will also be required.

How to install

Installation

Here are a couple of ways to clone this repo:

1. Software
   Android Studio -> File -> New -> From Version Control -> Git
   Enter https://github.com/laracassandra/nimble.git into the URL field and press the Clone button.

2. Clone Repository
   Run the following in the command-line to clone the project:

   git clone https://github.com/laracassandra/nimble.git

   Open Software and select File | Open... from the menu. Select cloned directory and press Open button

3. Install Dependencies
   Run the following in the command-line to install all the required dependencies:

   npm install

4. Get a free API Key at https://example.com and enter it in the config.js file:

   const API_KEY = 'ENTER YOUR API';

Features and Functionality

Feature 1

Description of Feature

Feature 2

Description of Feature

Feature 3

Description of Feature

Concept Process

The Conceptual Process is the set of actions, activities and research that was done when starting this project.

Ideation

Wireframes

User-flow

Development Process

The Development Process is the technical implementations and functionality done in the frontend and backend of the application.

Implementation Process

• Made use of both functionality to implement a specific feature.
• MVC/MVVM design architecture implemented.
• Plugin for this.
• ETC.

Highlights

• Sunshine.
• Rainbows.

Challenges

• Bugs.
• Bugs.

Reviews & Testing

Feedback from Reviews

Peer Reviews were conducted by my fellow students and lecturer. The following feedback I found useful:

• Feedback one.
• Feedback two.

Unit Tests

Unit Tests were conducted to establish working functionality. Here are all the tests that were ran:

• Test 1 of this functionality
• Test 2 of this functionality

Future Implementation

• Future 1.
• Future 2.

Final Outcome

Mockups

Video Demonstration

To see a run through of the application, click below:

View Demonstration

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Authors

• Lara Cook - laracassandra

License

Distributed under the MIT License. See LICENSE for more information.\

Contact

• Lara Cook - larac.cook@gmail.com
• Project Link - https://github.com/laracassandra/nimble

Acknowledgements

• Lecturer: Armand Pretorius
• Resource Name
• Resource Name
• Resource Name
• Resource Name