Skip to content

AmanTrivedi1/TakeNotes

Repository files navigation

Take Note

Welcome to TakeNote, a simple web application that allows users to create, store, and share notes with others. With TakeNote, you can easily jot down your thoughts, ideas, and important information and then share it with friends, family, or colleagues. One unique feature of TakeNote is that shared notes are read-only, ensuring the integrity of your original content.

Getting Started

To get started with TakeNote, follow these steps:

Clone the Repository: Begin by cloning this repository to your local machine using the following command:

git clone https://github.com/yourusername/takenote-app.git

Install Dependencies: Ensure you have the necessary dependencies installed for the application. You may use npm or yarn for this, depending on your preference.

npm install

Start the Application: You can start the application by running the following command:

npm run dev 

Access the Application: Open your web browser and navigate to http://localhost:3000 to access TakeNote.

Contributing

If you'd like to contribute to the development of TakeNote, follow these steps: Make your changes and commit them:

git checkout -b feature/your-feature-name

Make your changes and commit them:

git commit -m "Added a new feature"

Push your changes to your fork:

git push origin feature/your-feature-name

Env Reference

| CONVEX_DEPLOYMENT | ########### |

| NEXT_PUBLIC_CONVEX_URL | ########### |

| NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY | ########### |

| CLERK_SECRET_KEY | ########### |

| EDGE_STORE_ACCESS_KEY | ########### |

| EDGE_STORE_SECRET_KEY | ########### |

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors