StickyNotes

Organize tasks efficiently with StickyNotes!

Report Bug · Request Feature

Table of Contents

• About the Project
• Features
• Getting Started
• Installation
• Roadmap
• Contributing
• License
• Built With
• Contact

About The Project

StickyNotes is an innovative web application made with Firebase to help you organize your tasks.

Features

Current Features:

• Login to your personal account
• Signup with a new Account
• Add new StickyNote
• All StickyNotes saved into unique stores in Realtime Database

Coming Soon:

• Delete StickyNotes
• More StickyNote Personalization
• Settings

Getting Started

1. Clone the repo

git clone https://github.com/sanjaysunil/StickyNotes

2. Open index.html to open StickyNotes.

3. Create an account or login to your account.

4. Start using StickyNotes!

Installation

1. Clone the repo

git clone https://github.com/sanjaysunil/StickyNotes

2. Open Firebase Console and open console with a new created Firebase Project.
3. Obtain your Firebase app credentials and replace with the credentials located in js/index.js

  var config = {
    apiKey: "",
    authDomain: "",
    databaseURL: "",
    projectId: "",
    storageBucket: "",
    messagingSenderId: "",
    appId: ""
  };
  firebase.initializeApp(config);

4. Go to the Authentication section of your project and enable Email/Password Signin as a sign up method.
5. Go to the Realtime Database section of your project and create a new database in test mode.
6. Open StickyNotes, create an account and start organizing tasks!

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.