Skip to content

afaraone/final-project

Repository files navigation

Build Status Code Climate GitHub license ForTheBadge built-with-love

Garden Todos

A web app that visualises your todo lists as beautiful gardens!

MVP interaction

Garden Todos: you complete a todo, a plant appears.

Getting Started

To get started, fork this repository. Open your terminal and navigate to the directory you wish to store this program in. In the Github repository, click on 'Clone or download' and copy the SSH key. In your terminal, type in 'git clone', paste the SSH key and press 'Enter'. You will now have a copy of our program on your machine.

Prerequisites

Before you can start the program, you first need to install its dependencies. Assuming you are in the root directory, run these commands in your terminal:

cd lifestyle-app-backend
gem bundle install
bundle' install

Then return to the root directory with 'cd ..' and run this command:

npm install

Running the tests

Our program uses RSpec for the backend and ---- for the frontend. To run the RSpec tests, cd into the backend directory and run:

rspec

To test the frontend, cd into the frontend directory and run:

npm run test

Running the style tests

Our program uses Rubocop for the backend and eslint for the frontend. To run the Rubocop tests, cd into the backend directory and run:

rubocop

To test the frontend, cd into the frontend directory and run:

npm run pretest

Deployment

Our app is continuously deployed on Heroku. To visit, go to TBA.

Built With

Ruby on Rails Nodejs React ReactNative

How it works

screenshot 2018-11-22 at 11 41 36

Authentication Token flow

alt text

Screenshots

To be inserted when the program is finished.

User Stories

MVP

As a user,
So I can prioritise important tasks,
I’d like to see my list of todos.

As a user,
So I can add important tasks,
I’d like to create new tasks for my todo list.

As a user,
So I can update my tasks,
I’d like to be able to mark todos as completed.

As a user,
So I can see my todos a different way,
I’d like to see a garden with seeds

As a user,
So I can have some visual motivation,
I’d like completed todos to replace seeds with trees.

Extra Features

As a user,
So I can have my own account,
I’d like to be able to sign up with my details.

As a user,
So I can use my account,
I’d like to be able to login with my details.

As a user,
So I can sign in the lazy way,
I'd like to sign into the app with my Google account.

As a user,
So I don't get distracted,
I'd like the app to send me an alert when I've been on social media for tool long.

As a user,
So I can remember the locations of my goals,
I'd like my goals to be seen on Google Maps.

As a user,
So I can be held accountable for not completing my goals,
I'd like the app to tell me that I was not physically at the location.

As a user,
So I can plan my week,
I'd like to see my goals in a calendar format.

As a user,
So I can better prioritise my important tasks,
I'd like to rank my goals in order of importance.

As a user,
So I can show that I'm more productive than my friends,
I'd like my completed goals to be shown in a high score.

As a user,
So I can access the app conveniently,
I'd like it to be a Google Chrome extension.

Contributing

To contribute towards this program, please fork this repo, make any alterations you see fit and submit a pull request. We will do our best to review them promptly.

Versioning

1.0.0

Authors

Andres Faraone-Pirie - https://github.com/afaraone Oliver Baum - https://github.com/olliebaum Thomas Miller - https://github.com/T-Miller0 Daniel Stephenson - https://github.com/djstephenson7

License

This product is licensed.

About

A web app that visualises your todo lists as beautiful gardens! Final project for Makers Academy.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors