REAL TIME COLLAB is a web application built with Ruby on Rails that allows users to manage documents, comments, and tasks efficiently. The application utilizes Devise for authentication and JWT for secure API access.
- User Authentication: Users can sign up, log in, and manage their accounts using Devise.
- JWT Authentication: Secure API access using JSON Web Tokens (JWT) for stateless authentication.
- Document Management: Users can create, read, update, and delete documents.
- Comments: Users can add comments to documents for collaboration and feedback.
- Task Management: Users can create and manage tasks associated with documents.
- Shared Documents: Users can share documents with other users and manage access.
- Ruby on Rails
- Devise for authentication
- JWT for token-based authentication
- PostgreSQL for the database
To set up the project locally, follow these steps:
-
Clone the repository:
git clonehttps://github.com/peterdgreat/real-time-collab-api cd real-time-collab-api
-
Install dependencies:
bundle install
-
Set up the database:
rails db:create rails db:migrate
-
Set environment variables:
Create a
.env
file in the root directory and add the following:DEVISE_JWT_SECRET_KEY=your_secret_key_here
-
Start the server:
rails server
-
Access the application: Open your browser and go to
http://localhost:3000
.
- Sign Up: Users can create an account by navigating to the sign-up page.
- Log In: After signing up, users can log in to access their dashboard.
- Manage Documents: Users can create, edit, and delete documents from their dashboard.
- Add Comments: Users can add comments to documents for collaboration.
- Manage Tasks: Users can create and manage tasks associated with their documents.