This is an online text editor that allows users to create, share, and collaborate on text editing projects. It is built with React.js frontend and a Firestore NoSQL database.
- React.js
- FireBase & Firestore
- Tailwind CSS Library
- Node
- create-react-app
- NPM
After registering their accounts with an email address and password, users can log in to their home page, where they can access projects that they have created, projects that they have joined from other Colab Design users, and the pending invitations that they haven't accepted yet. By clicking on any of the project icons, users can see the project detail. There is a text editing page, where they can edit the project text and save changes. Users can click the participants button to search the database for other Colab Design users who they would like to invite to join their projects. Users are queryable be first name, last name, and email address. Partial matches appear in a dropdown and are added by clicking on the entry.
- Clone this repository to your local machine
- Download Node and NPM if you haven't already
https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
- Navigate to the project directory
cd colab_design
and enter these commands:npm install
andnpm run start
- With the program running, copy the url
http://localhost:3000
into a browser window - You are now interacting with the app in the browser and can access its functions.
- No known bugs at this time
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
MIT
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Copyright (c) March 2023 Robert Onstott