coNote

Simply collaborate.

What is coNote?

Using ReactJS and Firebase, we hope to provide a lightweight and straightforward collaborative Markdown editor that doesn’t compromise on most of the core features that are available on other collaborative editors.

Motivation

Markdown is a lightweight markup language, designed to create formatted text easily using a plain text editor. It is a very useful tool when you need to write quick notes that look great. In addition, it is currently the go-to markup language in many situations, i.e. writing Reddit posts or GitHub Gists, creating static webpage websites (see blot.im and Jekyll), writing project documentation (see ReadTheDocs and MkDocs), etc.

Thus, when used in a team setting, it can result in faster turnover for simple work, whether writing class notes, meeting notes, project blog posts, project documentation, etc. Hence, we decided to create a collaborative Markdown editor.

Also, it just seems interesting to work on.

Background

coNote is a two-man project by Edbert Geraldy Cangdinata and Rama Aryasuta Pangestu for Orbital 2022.

Orbital (Independent Software Development Project) is an independent module offered by NUS School of Computing every summer break.

Note that this project is currently being developed as of the writing of this README, as such do not expect anything close to a ready-to-use product on this repository as of current.

Getting Started

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.\ Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.\ You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.\ See the section about running tests for more information.

npm run build

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.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.