Skip to content

orodrigojose/pomotext

Repository files navigation


Logo

PomoText

Simple pomodoro like terminal
Demo of Project »

online badge stars badge

overview

About the project

This project it's a simple pomodoro timer that uses commands to operate it

Getting Started

Dependencies

  • You need to have nodejs installed in your machine.

Installing

  • To execute project locally you need fork it git clone https://github.com/rodrigosj7/pomotext.git
  • Then go to the project folder and execute npm i to install the necessary dependencies

Executing program locally

  • How to run the program
  • Step-by-Step
# Run development
$ npm run dev

# Build project
$ npm run build

# Preview builded project
$ npm run preview

Contribute to the project

To contribute to the project, follow the next steps:

  1. Fork this repository.
  2. Create an branch: git checkout -b <branch_name>.
  3. Make your changes and commit them using conventional commits, i recommend using padroes-de-commits as a reference for your commits
  4. Send for the original branch: git push origin <nome_do_projeto> / <local>
  5. Create the pull request(PR).

Alternatively, check the GitHub documentation on how to create pull request.

Built with

  • Javascript
  • ReactJs
  • Vite
  • TailwindCSS
  • Netlify

Features

  • Create command to change the minutes and seconds
  • Added dynamic title
  • Create theme options
  • Create PS1 customization
  • Add more commands

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

Inspiration


Made with 💜 by Rodrigo José(rodrigosj7)


⬆ Back to the top