Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/diegovictor/goal-tracker

Foxbox Week Challenge #1. Goal Tracking app!
https://github.com/diegovictor/goal-tracker

editorconfig eslint foxbox goal-tracker goals javascript js node nodejs prettier react reactjs

Last synced: 16 days ago
JSON representation

Foxbox Week Challenge #1. Goal Tracking app!

Host: GitHub
URL: https://github.com/diegovictor/goal-tracker
Owner: DiegoVictor
License: mit
Created: 2022-01-16T17:36:51.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-01-13T14:38:09.000Z (10 months ago)
Last Synced: 2024-01-14T00:00:27.281Z (10 months ago)
Topics: editorconfig, eslint, foxbox, goal-tracker, goals, javascript, js, node, nodejs, prettier, react, reactjs
Language: JavaScript
Homepage: https://goal-tracker-app.netlify.app/
Size: 2 MB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Goal Tracker

[![Netlify Status](https://api.netlify.com/api/v1/badges/fc275060-c266-4258-83b5-2865e6f335af/deploy-status)](https://app.netlify.com/sites/goal-tracker-app/deploys)

[![AppVeyor](https://img.shields.io/appveyor/build/diegovictor/goal-tracker?logo=appveyor&style=flat-square)](https://ci.appveyor.com/project/DiegoVictor/goal-tracker)

[![react](https://img.shields.io/badge/reactjs-18.2.0-61dafb?style=flat-square&logo=react)](https://reactjs.org/)

[![styled-components](https://img.shields.io/badge/styled_components-6.0.1-db7b86?style=flat-square&logo=styled-components)](https://styled-components.com/)

[![eslint](https://img.shields.io/badge/eslint-8.43.0-4b32c3?style=flat-square&logo=eslint)](https://eslint.org/)

[![airbnb-style](https://flat.badgen.net/badge/style-guide/airbnb/ff5a5f?icon=airbnb)](https://github.com/airbnb/javascript)

[![jest](https://img.shields.io/badge/jest-29.5.0-brightgreen?style=flat-square&logo=jest)](https://jestjs.io/)

[![coverage](https://img.shields.io/codecov/c/gh/DiegoVictor/goal-tracker?logo=codecov&style=flat-square)](https://codecov.io/gh/DiegoVictor/goal-tracker)

[![MIT License](https://img.shields.io/badge/license-MIT-green?style=flat-square)](https://raw.githubusercontent.com/DiegoVictor/goal-tracker/main/LICENSE)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

Log in with one email and start manage your goals, you can create, update or delete goals, set deadlines, descriptions, search between them, create tasks to each goal and set the goals and tasks as done.

Live Demo: https://goal-tracker-app.netlify.app/

## Table of Contents

* [Screenshots](#screenshots)

* [Installing](#installing)

* [Usage](#usage)

  * [Login](#login)

  * [localStorage](#localstorage)

* [Running the tests](#running-the-tests)

  * [Coverage Report](#coverage-report)

# Screenshots

Click to expand.








# Installing

Easy peasy lemon squeezy:

```

$ yarn

```

Or:

```

$ npm install

```

> Was installed and configured the [`eslint`](https://eslint.org/) and [`prettier`](https://prettier.io/) to keep the code clean and patterned.

# Usage

To start the app run:

```

$ yarn start

```

Or:

```

npm run start

```

## Login

Your email is used just to store your data and keep separated from other users in your browser, any kind of ads or newsletter will not be sent to you.

## localStorage

The project saves your goals into a [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) key: a [SHA3](https://cryptojs.gitbook.io/docs/#hashing) hash of your email. Before use this data you need parse the data to a JavaScript object with [`JSON.parse`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse) function. Below you can see fictitious data:

```json

{

  "goals": [

    {

      "id": 1642907083631,

      "title": "Create goal tracker web application",

      "description": "Develop the application to manage goals",

      "deadline": "2022-01-31",

      "tasks": [

        {

          "id": 1642907169966,

          "done": true,

          "title": "Create home page"

        },

        {

          "id": 1642907177520,

          "done": true,

          "title": "Create dashboard page"

        }

      ],

      "done": true,

      "completedAt": "2022-01-23T03:06:18.392Z",

    },

    {

      "id": 1642907124252,

      "title": "To document API routes",

      "description": "Write the API's documentation",

      "deadline": "2022-01-28",

      "tasks": [],

      "done": false,

    }

  ]

}

```

# Running the tests

[Jest](https://jestjs.io) was the choice to test the app, to run:

```

$ yarn test

```

Or:

```

$ npm run test

```

## Coverage report

You can see the coverage report inside `tests/coverage`. They are automatically created after the tests run.