Skip to content

Juno-4-U-2-Write/4-u-2-write

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

4-U-2-Write

This is a free Single Page Application (SPA) designed to provide a focused writing environment for writers and diarists. The app offers a writing prompt, a timer, and a quiet space to write, helping users to concentrate on their creative work.

Features

  • Choose a custom amount of time for writing.
  • Start a timer to track the writing session.
  • Warning notification if the user is not typing for more than 15 seconds during the writing session.
  • Uncluttered user interface to promote focus.
  • Light and Dark mode for personalized preference.
  • Communal daily writing prompt allowing users to contribute new prompts.
  • Proper error handling for scenarios such as no search results found.
  • Handling of common error responses.
  • Loading states for API interactions.

Stretch Goals

  • Option to title and save written work to Firebase or export it as a PDF after the timer finishes.
  • Suggestion of a song/playlist from Spotify, iTunes Playlist API, or any other API, matching the duration of the timer.

Technologies Used

  • HTML, CSS, JavaScript
  • Firebase (optional, for data storage)
  • APIs for communal writing prompts, song/playlist suggestions, and error handling

Installation

  1. Clone the repository: git clone https://github.com/your-username/writing-app.git
  2. Navigate to the project directory: cd writing-app
  3. Open the index.html file in a web browser.

Usage

  1. Upon opening the app, the user will be presented with a clean and focused user interface.
  2. Choose the desired amount of time for the writing session.
  3. Click the "Start" button to begin the timer.
  4. Type your content in the provided writing area.
  5. If there is no typing activity for more than 15 seconds, a warning will remind you to focus on writing.
  6. After the timer finishes, you may have the option to title and save your work or export it as a PDF.
  7. You can also participate in the communal daily writing prompt or contribute new prompts.
  8. Enjoy your writing experience and unleash your creativity!

Contributing

Contributions are welcome! If you would like to enhance the app or fix any issues, please follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature/your-feature-name
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin feature/your-feature-name
  5. Submit a pull request.

Acknowledgements

  • Firebase for optional data storage capabilities.
  • API providers for writing prompts, song/playlist suggestions, and error handling.
  • Developers and contributors of libraries and frameworks used in this project.

Feel free to customize the README.md file according to your project's specific details and requirements.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •