Noteey

Noteey is a note-taking web application for taking notes, writing articles, and so on. Unlike other note-taking applications, noteey has a color-personalized feature where users can pick a random color that they want their app to look like aside from the dark and light mode feature.

Hosted site

To view noteey on your browser, Click here

Tech Stacks

• UI - Nextjs and typescript
• Database - Firestore
• Authentication - Firebase
• styling - Tailwind CSS
• state management - Redux

Prerequisites

Before getting started, make sure you have the following prerequisites:

• Node.js installed
• Git installed
• npm (Node Package Manager) installed
• A code editor such as Visual Studio Code or any other preferred code environment

Ensure you have these prerequisites installed and set up on your system before proceeding with the project setup.

How to run the project

Follow the steps below to install and set up the project:

1. Fork the Repository: Fork the noteey project to your own GitHub account.

2. Clone the Repository: Clone the forked repository to your local machine by running the following command in your terminal:

   git clone https://github.com/your-username/noteey
   

3. Create a New Branch: Create a new branch to work on your desired features using the following command:

   git checkout -b feature
   

4. Install Dependencies: Navigate to the project folder on your terminal and install the dependencies using the following command:

   npm install
   

5. Run the Front-end: Start the application by running the following command:

   npm run dev
   

6. Make Changes: Now that you have set up your environment and created a new branch, you can start making your changes. You can modify existing code, add new features, or fix bugs.

7. Commit Your Changes: Once you have made your changes, commit them to your local branch using the following commands:

   git add .
   git commit -m "Your commit message"
   

8. Push Changes: Push your changes to your main branch and upload them to your GitHub account using the following command:

   git push origin "name of your branch"
   

9. Open a Pull Request: Finally, open a pull request in the original noteey repository