Untitled Notes

A Notetaking Application with Realtime Markdown and Collaborative Features

Explore

Table Of Contents

• Table Of Contents
• Overview
• Built With
• Getting Started
  • Prerequisites:
  • Installation:
• License
• Acknowledgements

Overview

Untitled Notes features a realtime markdown editor with a multitude of features within; including live collaboration sessions with friends utilising WebRTC and YJS. This application was built during the last three weeks of the Northcoders bootcamp. It was built in Nextjs, with Firebase as a backend and TypeScript as the main language. We decided to use eslint, prettier, and Husky to enforce a style guide with pre-commit hooks.

Built With

Getting Started

The website is hosted on Vercel, if you'd like to view it click here to view and interact with it through your browser (Firefox recommended for the larger range of support for the WebRTC API). Alternatively, you can follow the steps below to have it operating locally on your machine.

Prerequisites:

• Fork and clone the repository on your machine.

• Make sure you have Node >v14.x and the latest version of NPM installed.

• Have a Firebase account set up with a project that has Firestore and Firebase Authentication enabled.

Installation:

• cd into the cloned repo and run npm install to install the dependencies.

• Create a .env.local file in the root folder with the following structure:

  NEXT_PUBLIC_FIREBASE_API_KEY=
  NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=
  NEXT_PUBLIC_FIREBASE_PROJECT_ID=
  NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=
  NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=
  NEXT_PUBLIC_FIREBASE_APP_ID=
  NEXT_PUBLIC_ABLY_API_KEY=
  

• Once all dependencies are installed, you can use the command npm run dev to begin hosting a local development server for the website to be hosted upon.

License

This API is released under the terms of MIT License.

Acknowledgements

Thanks to the whole team at Northcoders for providing such an incredible learning environment.