almadhoob / space-threads

A collaborative writing app project for General Assembly bootcamp.

SpaceThreads

Unveiling the Universe, One Story at a Time.

📔 Table of Contents

• About the Project
  • Data Model
  • User Stories
  • Tech Stack
  • Features
• Getting Started
  • Prerequisites
  • Installation
  • Deployment
• Usage
• Roadmap
• Contributing
• FAQ
• License
• Contact
• Acknowledgements

🌟 About the Project

Welcome to the universe of creativity and collaboration – SpaceThreads! Conceived by a talented team comprising Ali Haji (the spaceship captain) along with Ahmed Almadhoob, Hamad Alhibshi, and Qasim Alkuwaiti for their final capstone at General Assembly, it is a web application that reimagines storytelling.

Inspired by the boundless expanse of infinite space and the concept of parallel universes, SpaceThreads is a dynamic platform that empowers individuals to craft their own unique stories. With the robust Django backend and the engaging React frontend, this project brings together the best of web development.

At SpaceThreads, the traditional boundaries between authors and readers dissolve, creating an interactive space where stories come to life through collaboration. Whether you're a seasoned writer or a newcomer, SpaceThreads offers an innovative stage for your literary aspirations.

Join us in this cosmic journey, where storytelling has no limits. Explore SpaceThreads and dive into a universe where creativity knows no bounds – your literary adventure awaits!

• Collaborative Writing
• Networked Books

🌟 Data Model

The Entity Relationship Diagram (ERD):

🌟 User Stories

We have asked six types of users what features and why they want to use the application, and the survey results were as the following:

• As an Aspiring Writer: I want to write and publish stories: To share my creativity with the community.
• As a Participating Writer: I want to collaborate with others: To co-author stories and learn from fellows.
• As a Learning Writer: I want to receive reviews and comments: To improve myself and connect with readers.
• As a Reader and Enthusiast: I want to browse a diverse library of stories: So I can discover new authors.
• As a Critical Reader: I want to leave comments and feedback: To engage with authors and fellow readers.
• As an Administrator: I want to manage user accounts: To ensure a safe and enjoyable platform experience.

🌟 Tech Stack

Frontend

• HTML, CSS, JavaScript
• React Frontend Framework
• Material UI Component Library
• Emotion.js Styling Library
• Chroma.js Color Library
• Web Vitals Metrics
• Axios HTTP Client

Backend

• Python Programming Language
• Django Backend Framework
• Django REST Framework
• Django CORS Headers
• Python JWT Implementation
• Cloudinary Image API
• Gunicorn WSGI HTTP Server

DevOps, Databases, etc.

• GitHub Enterprise
• Render Cloud Hosting
• Docker Containerization
• Nginx Web Server
• PostgreSQL Database
• Neon Database PaaS

🌟 Getting Started

🌟 Prerequisites

This project uses Node.js (with NPM package manager) and Django (with PIP package manager).

To run this project, you have to add the following environment variables to your '.env' file: SECRET_KEY, DJANGO_ALLOWED_HOSTS, DB_ENGINE, DB_DATABASE, DB_USER, DB_PASSWORD, DB_HOST, DB_PORT.

🌟 Installation

Clone the project:

  git clone [e-mail]:almadhoob/space-threads.git

Go to the project directory:

  cd space-threads

Install dependencies:

  npm install

Start the server:

  npm run start

🌟 Deployment

To deploy this project run:

  npm deploy

🌟 Roadmap

• Deployment CI/CD
• Frontend Dashboard

🌟 Contributing

Contributions are always welcome. Click here to request a feature or report a bug.

⚠️ License

Distributed under the MIT License. Click here for more information.

💎 Acknowledgements

We would like to thank Tor Johnson, Avan Sardar, Ahlam Almutawa and Rawan Alqassab.