Skip to content

Tale Sharing Website! This platform allows users to share their secret tales anonymously.

Notifications You must be signed in to change notification settings

fredrickreuben/anontales

Repository files navigation

Anonymous Tale Sharing Website

Welcome to the Anonymous Tale Sharing Website! This platform allows users to share their secret tales anonymously. Other users can read and comment on these tales, maintaining complete anonymity throughout the process. Share your tales, read others' stories, and engage in a safe and anonymous community.

Table of Contents

Technologies Used

  • ReactJS 18
  • NextJS 13
  • Axios
  • Firebase (Firestore and Authentication)
  • Clear Auth
  • React Images Uploading
  • Editor.js (A block-styled editor for rich text editing)
  • Headless UI (Accessible UI components)
  • React Hook Form (Form validation library)
  • Redux Toolkit (State management)
  • Radix UI (Composable and accessible components)
  • Class Variance Authority (Classname utility library)
  • clsx (A utility for constructing className strings)
  • Tailwind Merge (Utility to merge Tailwind CSS classes)
  • TailwindCSS
  • TypeScript

Installation

  1. Clone the repository: `https://github.com/fredrickreuben/anontales.git``
  2. Navigate to the project directory: cd anontales
  3. Install the dependencies: npm install

Usage

  1. Start the development server: npm run dev
  2. Open your browser and visit: http://localhost:3000
  3. Users can anonymously share their tales by creating new posts using the provided editor.
  4. Users can also edit their own tales if needed.
  5. Other users can read the shared tales and comment anonymously.

Features

  1. Share Tales Anonymously: Users can write and share their secret tales anonymously using the Editor.js block-styled editor.
  2. Edit Tales: Users have the option to edit their own tales if they wish to make changes or add more details.
  3. Create Comments Anonymously: Readers can comment on the shared tales without revealing their identity, fostering an anonymous and safe environment.

Contributing

Contributions to the Anonymous Tale Sharing Website are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request. Please ensure that your contributions adhere to the code quality and style of the project.

To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix: git checkout -b my-new-feature
  3. Make your changes and commit them: git commit -am 'Add some feature'
  4. Push the branch to your fork: git push origin my-new-feature
  5. Submit a pull request to the main branch of the original repository.

License

This project is licensed under the MIT License.

Live Demo

Check out the live demo of the Anonymous Tale Sharing Website here.

About

Tale Sharing Website! This platform allows users to share their secret tales anonymously.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published