https://github.com/rishiosaur/hoot
🌌 The assignment tracker for tech-savvy students. Built using Inquirer, Commander, and Node.
https://github.com/rishiosaur/hoot
hacktoberfest hoot-cli school
Last synced: 2 months ago
JSON representation
🌌 The assignment tracker for tech-savvy students. Built using Inquirer, Commander, and Node.
- Host: GitHub
- URL: https://github.com/rishiosaur/hoot
- Owner: rishiosaur
- License: mit
- Created: 2019-08-16T10:43:45.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T13:38:10.000Z (over 2 years ago)
- Last Synced: 2024-04-10T14:16:33.902Z (about 1 year ago)
- Topics: hacktoberfest, hoot-cli, school
- Language: JavaScript
- Homepage:
- Size: 1.31 MB
- Stars: 22
- Watchers: 5
- Forks: 2
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-hackclub - Hoot - [@rishiosaur](https://github.com/rishiosaur) - **(JavaScript)** _An assignment tracker for tech-savvy students!_ (CLI Tools)
README
# Hoot-cli
The assignment tracking system for tech-savvy students.
[](https://npmjs.org/package/hoot-cli "View this project on npm")
[](https://www.codacy.com/manual/rishiosaur/hoot-cli?utm_source=github.com&utm_medium=referral&utm_content=rishiosaur/hoot-cli&utm_campaign=Badge_Grade)
[](https://asciinema.org/a/266563)
## Usage
How to use `Hoot`
### Installation
Hoot is available on the npm registry, so installation is a breeze:
`npm i -g hoot-cli`
Alternatively, you can run
`npx hoot `
#### Setup
If you have `hoot` installed locally, you can run `hoot setup`, or `npx hoot setup`.
### Structure
```
+----------------------------------------------+
| |
| School |
| + |
| | |
| +--+ {Subject} |
| + |
| +-> {Unit} |
| + |
| | |
| +-> Assignments |
| | + |
| | +-> {Assignment} |
| | |
| +-> Homework |
| | |
| | |
| | |
| +-> Finished |
| | |
| | |
| +-> Notes |
| |
| |
| Folder Structure |
+----------------------------------------------+
```
Before creating assignments, you will need to create the associated units and subjects using the `hoot unit` and `hoot subject` commands, respectively.
### Subjects
Hoot runs on this folder directory:
`School / Term / / / `
To generate a subject directory with `hoot.json`, run:
`hoot new subject `
Where `` is the name of the subject.
Use the `hoot new ` command for creation of subjects, units, assignments, or notes!
### Assignments
Assignment generation is done using the `hoot assignment ` command, and templating is done by copying an assignment template in the `templates/` folder.