Take Notes

The realtime notes keeping pwa for all platforms ✨
Explore the docs »
Website . Report Bug . Request Feature

Table of Contents

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

About The Project

There are a lot of ToDO/Notes tracker available online, however, I didn't find one that is realtime and cross-platform at the same time for all devices and would suit my needs so I created this one.

Here's why:

• Multi-platform support accross all possible devices
• Realtime changes reflected accross all platforms
• Your time should be focused on completing your tasks and working on something amazing
• Rather than you managing what to do next, this app helps you keep track of notes etc.
• Fully secure with Google authentication and firebase database no need to worry about security as well 😄

Built With

This project was bootstrapped with Create React App and some npm packages listed below:

• firebase
• reactstrap
• node-sass
• gh-pages

Getting Started

To get up and running with this project on your local machine follow these simple steps.

Prerequisites

Here's a list of things you'll need to use have prior to installing the software.

• npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/avisionx/take-notes.git

2. Install NPM packages

npm install

3. Setup a firebase project in your firebase console and click on "Add Firebase to your web app" to get prefilled config of this sorts

var firebaseConfig = {
  apiKey: '<your-api-key>',
  authDomain: '<your-auth-domain>',
  databaseURL: '<your-database-url>',
  projectId: '<your-cloud-firestore-project>',
  storageBucket: '<your-storage-bucket>',
  messagingSenderId: '<your-sender-id>'
};

4. Replace the above config varibale in index.js inside src folder

Usage

Once installed here are some basic commands that you may run for working on the project.

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Learn More For more examples, please refer to the Create React App Documentation

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.

Contact

Avi Garg - https://avisionx.net/ - [email protected]

Project Link: https://github.com/avisionx/take-notes