Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peterdgreat/real-time-collab-api
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.
https://github.com/peterdgreat/real-time-collab-api
Last synced: 5 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/peterdgreat/real-time-collab-api
- Owner: peterdgreat
- Created: 2024-09-03T16:10:28.000Z (5 months ago)
- Default Branch: dev
- Last Pushed: 2024-11-15T09:34:31.000Z (2 months ago)
- Last Synced: 2024-11-15T10:33:42.609Z (2 months ago)
- Language: Ruby
- Homepage:
- Size: 95.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# REAL TIME COLLAB
## Description
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.
## Features
- **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.
## Technologies Used
- Ruby on Rails
- Devise for authentication
- JWT for token-based authentication
- PostgreSQL for the database
## Installation
To set up the project locally, follow these steps:
1. **Clone the repository**:
```bash
git clonehttps://github.com/peterdgreat/real-time-collab-api
cd real-time-collab-api
```
2. **Install dependencies**:
```bash
bundle install
```
3. **Set up the database**:
```bash
rails db:create
rails db:migrate
```
4. **Set environment variables**:
Create a `.env` file in the root directory and add the following:
```bash
DEVISE_JWT_SECRET_KEY=your_secret_key_here
```
5. **Start the server**:
```bash
rails server
```
6. **Access the application**: Open your browser and go to `http://localhost:3000`.
## Usage
- **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.