Skip to content

Ganeshmoorthii/notes-app

 
 

Repository files navigation

🚀 Introduction

Scribbie is a powerful, intuitive note-taking website built specifically for working professionals who want to manage their notes seamlessly and effectively.


🔥 Tech Stack

  • Frontend: React.js, TailwindCSS, React Hot Toast
  • Backend: Node.js, Express.js, MongoDB
  • Authentication: Google Auth
  • Deployment: Vercel

💻 Getting Started

Prerequisites

Before you begin, ensure that you have the following installed:

  1. Node.js: Download Node.js
  2. MongoDB: Download MongoDB
  3. Git: Download Git

🚀 Running Scribbie on Your Local Machine

Follow these steps to get Scribbie running on your local machine:

  1. Clone the repository:

    git clone https://github.com/yashmandi/notes-app.git
  2. Navigate to the project directory:

    cd notes-app
  3. Install dependencies for both backend and frontend:

    • Install backend dependencies:

      cd backend
      npm install
    • Install frontend dependencies:

      cd ../frontend
      npm install
  4. Set up environment variables: Create .env files in both backend and frontend directories with the necessary values.
    Here's a sample configuration:

    Backend .env:

    # Backend Environment Variables
    PORT=5000
    MONGODB_URI=mongodb://localhost:27017/your-database-name
    GOOGLE_API_TOKEN=your_google_api_token_here

    Frontend .env:

    # Frontend Environment Variables
    VITE_BACKEND_URL=http://localhost:5000
    VITE_REACT_APP_GOOGLE_API_TOKEN=your_google_api_token_here
  5. Run the project:

    • Run the backend server:
      cd backend
      npm start
    • Run the frontend:
      cd ../frontend
      npm run dev

📚 Contribution Guidelines

We welcome contributions from the community! Please see the CONTRIBUTING.md file for detailed guidelines.


👀 Our Contributors

  • We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating Ratna-Supermarket to greater heights.
  • Make sure you show some love by giving ⭐ to our repository.

🤝 Code of Conduct

All contributors must adhere to our CODE_OF_CONDUCT to ensure a positive collaboration environment.


🎉 Happy Contributing! Let’s work together to make Scribbie an even better tool!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 98.1%
  • CSS 1.7%
  • HTML 0.2%