Skip to content

Repository files navigation

Notescape

Notescape is a web-based platform designed to simplify document management and note-taking for both personal and organizational purposes. With its user-friendly interface and versatile features, Notescape allows users to store, create, and view notes effortlessly.

Features

  • Document Storage: Securely store and manage your documents in one place.
  • Note Creation: Easily create notes for personal or professional use.
  • Note Viewing: Access and view your notes anytime, anywhere.
  • User-Friendly Interface: Intuitive design for a seamless experience.
  • Organizational Use: Ideal for teams and businesses to collaborate effectively.

Tech Stack

  • Frontend: Next JS, Typescript
  • Backend: Clerk
  • Database: Convex

Installation

Follow these steps to set up the project locally:

  1. Clone the repository:

    git clone https://github.com/your-username/notescape.git
  2. Navigate to the project directory:

    cd notescape
  3. Install dependencies:

    npm install
  4. Start the development server:

    npm start
  5. Open your browser and navigate to:

    http://localhost:3000
    

Usage

  1. Sign up or log in to access your account.
  2. Create new notes or upload documents to store them securely.
  3. View and manage your notes and documents as needed.

Live Demo

Check out the live version of Notescape here: https://notescape-saurin.vercel.app/

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix:
    git checkout -b feature-name
  3. Commit your changes:
    git commit -m "Add feature description"
  4. Push to your branch:
    git push origin feature-name
  5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contact

For any questions or suggestions, feel free to contact us:

About

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages