Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 3.23 KB

README.md

File metadata and controls

76 lines (50 loc) · 3.23 KB
Raw

Netlify Status Dependabot semantic-release

Prompter.me

An opensource teleprompter application for the browser.

Teleprompter

preview

What is Prompter.me?

Prompter.me is a free, open source teleprompter on the web. Using it doesn't require you to download anything or to sign up for anything. It was made to give content creators an actually useful free teleprompter, which would allow them to use it on their own without any additional apps or hacks. After all, a lot of video content creators out there are one-person operations, and we know using a prompter without help can be a real pain in the tuchus.

Server

The project's server side repository can be found here.

The server is currently deployed to AWS – Lambda. You can crate your own instane if you wish to have a self-hosted version of prompter. Or anywhere else if you wish, you need a node environment, and a MongoDB.

Contributors

  • 💅 design: Mikko Oitinen 🇫🇮 (design)
  • 💻 dev: Richard Zilahi http 🇭🇺

Project dependencies

This project heavily depends on the following open source projects.

  1. redux
  2. react-redux
  3. redux-thunk
  4. redux-persist
  5. styled-components
  6. use-socket.io-client
  7. uuid
  8. classnames
  9. prop-tpyes
  10. hex-to-rgba
  11. ... and a lot other

Developing

Contribution is very welcome! You need to clone this, and the server repository.

For the client:

  1. npm i
  2. npm run start
  3. The client is listening on :4444

For the server:

  1. npm install
  2. npm run dev
  3. The server is listening on :5000

Misc

This project is deployed via netlify.

Special thanks to @munkacsimark for helping me out with the scrolling function. 👋

This is most listened song during the development of promoter.me.

Licence

This is a free product, and it's licenced under BSD 3-Clause License.