https://github.com/chris-aqui/nebulanotes

NebulaNotes, a notion app clone
https://github.com/chris-aqui/nebulanotes

css-modules project react-router-dom reactjs superbase typescript vite

Last synced: 2 months ago
JSON representation

NebulaNotes, a notion app clone

• Host: GitHub
• URL: https://github.com/chris-aqui/nebulanotes
• Owner: chris-aqui
• Created: 2024-05-26T21:00:17.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-08-30T21:15:14.000Z (4 months ago)
• Last Synced: 2024-10-15T17:35:19.306Z (2 months ago)
• Topics: css-modules, project, react-router-dom, reactjs, superbase, typescript, vite
• Language: TypeScript
• Homepage: https://nebulanotes.netlify.app
• Size: 7.14 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# NebulaNotes

https://nebulanotes.netlify.app/

**NebulaNotes** is a powerful web application that allows users to create, manage, and organize notes in a flexible tree structure. Designed as a Notion-like tool, NebulaNotes offers a rich set of features for both individual and collaborative productivity.

## Features

- **Authentication**: Secure user authentication powered by Supabase.

- **Note Management**: Create, update, reorder, and delete notes with ease.

- **Image Management**: Upload, update, and remove images associated with your notes.

- **Page Customization**: Modify page titles and cover images to personalize your workspace.

- **Page Management**: Create, update, and delete entire pages for comprehensive content organization.

## Tech Stack

NebulaNotes is built with modern technologies for a smooth and responsive user experience:

- **React**: For building interactive user interfaces.

- **TypeScript**: Ensuring type safety and reducing errors in your code.

- **Vite**: A fast build tool and development server for a seamless development experience.

- **DndKit**: A drag-and-drop toolkit that powers the reordering of notes.

- **TailwindCSS**: A utility-first CSS framework for quick and responsive design.

- **Supabase**: Provides backend services including database, authentication, and storage.

- **Netlify**: For fast and reliable hosting.

## Running the App Locally

To run NebulaNotes on your local machine, follow these steps:

1. **Set Up Supabase**: Create a new project in Supabase and obtain your project URL and API key.

2. **Configure Environment Variables**: Add the following environment variables to your `.env` file:

   ```

   VITE_SUPABASE_URL="your-supabase-url"

   VITE_SUPABASE_API_KEY="your-supabase-api-key"

   ```

3. **Install Dependencies**: Install the required dependencies by running:

   ```

   npm install

   ```

4. **Start the Development Server**: Start the app using either of the following commands:

   ```

   npm run dev

   ```

   or

   ```

   netlify dev

   ```

---

Screenshots







----

### future functions/features (To Do)

- support markdown

- page directory

- popup notifications instead of alerts

- tags

- search bar

- dark mode

- share notes?