Skip to content

uint82/stickynote

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Sticky Note 📌📝

image

Your digital cork board for organizing thoughts, tasks, and reminders with beautiful, customizable sticky notes.

✨ Features

🎨 Complete Customization

  • Note Colors: Choose from a wide palette of background colors for your notes
  • Text Colors: Customize text color for better readability or style
  • Editing: Change text and colors

📱 Intuitive User Experience

  • Drag & Drop: Arrange notes anywhere on your board with simple dragging
  • Resizable Notes: Expand notes for longer content or shrink them to save space
  • Expandable View: Click to expand notes for better reading and editing
  • Smooth Animations: Fluid transitions when creating, moving, or resizing notes

💾 Smart Storage Solutions

  • User Accounts: Create an account to sync notes across devices
  • Local Storage: Notes automatically saved locally for users without accounts
  • Auto-Save: Changes are saved instantly to prevent data loss

🔐 Security & Privacy

  • Secure Authentication: Email/password with OAuth options for social login
  • Private Notes: All notes are private to your account
  • Encrypted Storage: Note contents are encrypted in our database

🛠️ Tech Stack

  • Frontend: React, Redux, Styled Components, React DnD (drag and drop)
  • Backend: Django, Django REST Framework
  • Database: MySQL
  • Authentication: JWT, Social OAuth
  • Storage: Local Storage (unauthenticated), MySQL (authenticated)
  • Deployment: Pythonanywhere and netlify

🚀 Getting Started

Prerequisites

  • Python 3.8+
  • Node.js 14+
  • MySQL 8.0+
  • Git

Installation

  1. Clone the repository
git clone https://github.com/uint82/stickynote.git
cd stickyboard
  1. Set up the backend
# Create and activate virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install Python dependencies
pip install -r requirements.txt

# Configure environment variables
cp backend/.env.example backend/.env
# Edit the .env file with your database credentials and secret key

# Run migrations
cd backend
python manage.py migrate

# Start the Django server
python manage.py runserver
  1. Set up the frontend
# Navigate to frontend directory
cd ../frontend

# Install JavaScript dependencies
npm install

# Start the React development server
npm start
  1. Access the application
  • Open your browser and go to http://localhost:3000

Manual Deployment

Detailed instructions for deploying to various platforms:

🔄 Roadmap

Future Considerations

  • Desktop application with offline support

👥 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

🐛 Bug Reports & Feature Requests

If you encounter any bugs or have ideas for new features, please open an issue on GitHub.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

📬 Contact


Made with ❤️ by uint82

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •