TaleThread

Social media app for creative writers.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. Contact

About The Project

TaleThread is a social media application designed to enhance story writing through collaborative features and real-time assistance.

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

• Django REST Framework

  pip install djangorestframework

Installation

1. Clone the repo

   git clone https://github.com/self-sasi/talethread.git

2. API and SQLite db config

   To use the creative writing AI feature, you will need to insert your own OpenAI API key in a new file named backend/.env. Follow the format in backend/.env.example

   cd backend
   python manage.py makemigrations user_auth
   python manage.py migrate user_auth
   python manage.py makemigrations user_profile
   python manage.py migrate user_profile
   python manage.py makemigrations threads
   python manage.py migrate threads

   Run the API server

   python manage.py runserver

3. Frontend config (in a new terminal)

   cd frontend
   npm install
   ng serve

Application will be running at http://localhost:4200/

(back to top)

Usage

1. Collaborative Story Writing
   Create and edit stories collaboratively with other users. Simply start a new story or join an existing one, and collaborate in real-time to develop engaging narratives.
   

2. Real-Time Writing Assistance
   Receive instant writing suggestions and creative input powered by OpenAI’s GPT-4o API. This feature helps you refine your content and overcome writer’s block efficiently.
   

3. User-Friendly Interface
   Navigate the application effortlessly with our user-centric interface built using Angular and TailwindCSS.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Sarthak Singh - in/SarthakSingh
Adon Ojha - in/AdonOjha
Kushagra Kapoor - in/KushagraKapoor

(back to top)