https://github.com/olivpeter/inorbit-terminal

InOrbit is a Goal Checker that runs in terminal made with Javascript and NodeJS. Study project developed during NLW Pocket in Sep 2024 by Rocketseat.
https://github.com/olivpeter/inorbit-terminal

javascript nodejs terminal-based

Last synced: about 1 month ago
JSON representation

InOrbit is a Goal Checker that runs in terminal made with Javascript and NodeJS. Study project developed during NLW Pocket in Sep 2024 by Rocketseat.

• Host: GitHub
• URL: https://github.com/olivpeter/inorbit-terminal
• Owner: olivpeter
• License: mit
• Created: 2024-09-10T00:40:22.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-16T15:15:02.000Z (4 months ago)
• Last Synced: 2024-09-17T18:29:15.722Z (4 months ago)
• Topics: javascript, nodejs, terminal-based
• Language: JavaScript
• Homepage:
• Size: 874 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ![Logo](/assets/inorbit-logo.svg)

InOrbit is a Goal Checker that runs in terminal made with Javascript and NodeJS. Study project developed during NLW Pocket in Sep 2024 by [Rocketseat](https://www.rocketseat.com.br/).

![projectCover](/assets/inorbit-cover.jpg)

![Static Badge](https://img.shields.io/badge/PRs-Welcome-green?style=for-the-badge)

![Static Badge](https://img.shields.io/badge/State-Done-green?style=for-the-badge)

![Static Badge](https://img.shields.io/badge/License-MIT-dark_green?style=for-the-badge&link=.%2FLICENSE)

## 🧰 Features

-   Add, list, mark and remove goals

-   Create and save goals

-   Messaging system

![appShowOff](/assets/app-showoff.gif)

## 🔨 Technologies

![Static Badge](https://img.shields.io/badge/Javascript-grey?style=for-the-badge&logo=javascript)

![Static Badge](https://img.shields.io/badge/NodeJS-grey?style=for-the-badge&logo=node.js)

## ⚙️ Usage

-   Clone the repository

```bash

git clone https://github.com/olivpeter/inorbit-terminal.git

cd inorbit-terminal

```

-   Install dependencies

```bash

npm install

```

-   Run the application in terminal

```bash

node app.js

```

## 🫡 How to contribute

-   Fork the repository

-   Certify that you have the lastest version of the project

```bash

git pull

```

-   Create a new branch w/ this pattern: `feature/new-feature`

```bash

git checkout -b feature/new-feature

```

-   Commit your changes w/ conventional commit messages

-   Create a Pull Request

-   Wait review and merge to delete your old branch

```bash

git branch -D feature/new-feature

```

-   Good luck 🥳!

## 🔥 TODO

-   [x] Create goals

-   [x] List goals

    -   [x] Completed goals

    -   [x] Open goals

-   [x] Mark/Unmark goals as completed

-   [x] Remove goals

-   [x] Messaging system

-   [x] Load and Save goals in a JSON file (data persists)