cblanken / fire-kangaroo-sticky-notes

Home Page:https://fire-kangaroo-sticky-notes-api.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Fire Kangaroo Sticky Notes

Table of Contents

  1. About the Project
  2. Usage
  3. Built With
  4. Installation
  5. Contributions

About

Fire Kangaroo Sticky Notes is an easy-to-use application that allows you to write notes with authentication and drag-and-drop functionality. It provides the ability to store notes across multiple devices, ensuring seamless access from anywhere.

Usage

  • Users can create multiple sitcky notes with customizable colors.
  • Organize notes by dragging and dropping them to new positions.
  • Synchronize notes across multiple devices.

Built With

Future Features (Work in Progress)

  • Local storage sticky notes for unauthenticated users
  • Account confirmation emails
  • Drag & drop

Challenges

  • ALL THE THINGS
  • Authentication with passport
  • Hosting / live demo

Installation

# Download code
$ git clone https://github.com/Hack-Weekly/fire-kangaroo-sticky-notes.git sticky-notes

# Install dependencies
$ cd ./sticky-notes
$ npm install

# Run frontend and backend concurrently
$ npm run dev-concurrent

Contributions

  • How to help us improve the app
    • Anyone is welcome to contribute by making a pull request
    • If you find any bugs, please feel free to file an issue
  • Start by forking the project
  • Making contributions
  • After you've cloned your fork of the project, you will need to make a branch
$ git checkout -b name-of-branch
  • Make any changes, save your work, and make the necessary commits
$ git add . 
$ git commit -m "Add summary of the code you worked on"
$ git status

# Push the code to the branch you made to your fork
$ git push origin name-of-your-branch
  • Once you've pushed your branch, don't forget to make a pull request into the main branch.

About

https://fire-kangaroo-sticky-notes-api.vercel.app


Languages

Language:JavaScript 80.8%Language:CSS 15.1%Language:HTML 4.1%