GitNote

This is a Next.js project bootstrapped with create-next-app.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

📋 Table of Contents

1. 🌐 Demo
2. 🤖 Introduction
3. 📝 Description
4. ⚙️ Tech Stack
5. 🔋 Features
6. 🛠️ Setup
7. 🔍 Usage
8. ✅ To-do
9. 📜 Credits
10. 📚 References
11. 📞 Contact
12. 📋 License

🌐 Demo

Here is a working live demo: GitNote

🤖 Introduction

GitNote - Your all-in-one solution for developers, designed to be their second brain, a comprehensive learning tool, and an efficient progress tracker. Seamlessly capture and organise knowledge, set and track learning goals, and monitor study habits with ease. GitNote empowers developers to enhance their productivity and knowledge management skills effortlessly.

📝 Description

Welcome to my project! Here, I'll provide you with a brief overview of what inspired me to create it, why it solves a problem, and what I've learned throughout its development.

• Motivation: I was motivated to build this project to address a specific issue and to enhance my coding skills.
• Why I Built This Project: My main goal was to create a practical and user-friendly solution to a real-world problem.
• Problem Solved: This project aims to simplify a particular task, making it more efficient and accessible.
• What I Learned: Throughout the development process, I gained valuable insights into various technologies and programming concepts.

⚙️ Tech Stack

• Next.js
• TypeScript
• Prism.js
• TinyMCE
• MongoDB
• Shadcn
• Tailwind CSS
• Mongoose ORM
• Clerk
• AuthO
• React-Hook form
• Zod

🔋 Features

👉 Authentication & Onboarding: Seamlessly log in or sign up and personalize your experience with smooth onboarding.

👉 Profile Management: Easily update profile details and link social media accounts for enhanced connectivity.

👉 Creating Learning Posts: Document knowledge, components, or workflows effortlessly, enriched with resources and links.

👉 Related Posts: Connect related content seamlessly for improved information accessibility.

👉 Tagging for Context: Enhance post context and retrieval efficiency with intuitive tagging.

👉 Contribution Grid: Track progress visually as the grid dynamically updates with each post similar to Github.

👉 Goals & Experience Tracking: Monitor and reflect on learning goals conveniently from your profile.

👉 Search & Filter: Retrieve past notes and tutorials swiftly with global search and filtering.

👉 Post Collection: Explore content easily with pagination features, witnessing your learning progression firsthand.

👉 Responsive: Ensures seamless functionality and aesthetics across all devices and many more, including code architecture and reusability

🛠️ Setup Project

To get this project up and running in your development environment, follow these step-by-step instructions.

🍴 Prerequisites

We need to install or make sure that these tools are pre-installed on your machine:

• NodeJS: It is a JavaScript runtime build.
• Git: It is an open source version control system.

🚀 Install Project

1. Clone the Repository

git clone [email protected]:ManmeetSinghJohal/gitnote.git

2. Install packages

npm install

3. Create a .env file

NEXTAUTH_URL="http://localhost:3000"
NEXTAUTH_SECRET="BPYr......"          


GITHUB_ID="1621....."
GITHUB_SECRET="e1a17....."

GOOGLE_CLIENT_ID="147636175........"
GOOGLE_CLIENT_SECRET="GOCS......."

MONGODB_URL=mongodb+srv://........

MONGODB_URI=mongodb+srv://........

NEXT_PUBLIC_TINY_EDITOR_API_KEY='12kr.........'

4. Run the dev server.

npm run dev

🔍 Usage

How To Use

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone [email protected]:ManmeetSinghJohal/gitnote.git

# Go into the repository
$ cd projectname

# Install dependencies
$ npm install

# Run the app
$ npm run dev

Note If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

⚒️ How to Contribute

Want to contribute? Great!

To fix a bug or enhance an existing module, follow these steps:

• Fork the repo
• Create a new branch (git checkout -b improve-feature)
• Make the appropriate changes in the files
• Add changes to reflect the changes made
• Commit your changes (git commit -am 'Improve feature')
• Push to the branch (git push origin improve-feature)
• Create a Pull Request

📩 Bug / Feature Request

If you find a bug (the website couldn't handle the query and / or gave undesired results), kindly open an issue here by including your search query and the expected result.

If you'd like to request a new function, feel free to do so by opening an issue here. Please include sample queries and their corresponding results.

✅ To-do

Will update soon!

📜 Credits

None for this project.

📚 References

None at the moment.

📞 Contact Me

📋 License