# README

[![Contributors](https://img.shields.io/github/contributors/juniHub/juni-dev-notes.svg?style=for-the-badge)](https://github.com/juniHub/dev-note-v2/graphs/contributors) [![Forks](https://img.shields.io/github/forks/juniHub/juni-dev-notes.svg?style=for-the-badge)](https://github.com/juniHub/dev-note-v2/network/members) [![Stargazers](https://img.shields.io/github/stars/juniHub/juni-dev-notes.svg?style=for-the-badge)](https://github.com/juniHub/dev-note-v2/stargazers) [![Issues](https://img.shields.io/github/issues/juniHub/juni-dev-notes.svg?style=for-the-badge)](https://github.com/juniHub/dev-note-v2/issues) [![MIT License](https://img.shields.io/github/license/juniHub/juni-dev-notes.svg?style=for-the-badge)](https://github.com/juniHub/dev-note-v2/blob/master/LICENSE.txt) [![Netlify Status](https://api.netlify.com/api/v1/badges/9874ce42-fb6e-41e0-b6c0-907df9a865e7/deploy-status)](https://app.netlify.com/sites/juni-dev-note/deploys)

<br>

[![Logo](https://2569715370-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MacpSQbuKD_r7dffwiq%2Fsync%2F93631515789b36c1adf512cce5474c201d45ad0e.png?generation=1622035326176964\&alt=media)](hhttps://github.com/juniHub/dev-note-v2)

#### Juni Dev Notes

project\_description\
[**Explore the docs »**](https://github.com/juniHub/dev-note-v2)\
\
[View Demo](https://juni-dev-note.netlify.app/) · [Report Bug](https://github.com/juniHub/dev-note-v2/issues) · [Request Feature](https://github.com/juniHub/dev-note-v2/issues)

<details>

<summary>Table of Contents</summary>

1. [About The Project](#about-the-project)
   * [Built With](#built-with)
2. [Getting Started](#getting-started)
   * [Prerequisites](#prerequisites)
   * [Installation](#installation)
3. [Usage](#usage)
4. [Roadmap](#roadmap)
5. [Contributing](#contributing)
6. [License](#license)
7. [Contact](#contact)
8. [Acknowledgements](#acknowledgements)

</details>

### About The Project

![Juni-juni-dev-notes-screenshot](https://res.cloudinary.com/dafolrlpj/image/upload/v1638627689/gallery/usjlnzz4rf2z0mxzrs8r.png)

#### Built With

* [ReactJS](https://reactjs.org/)
* [Firebase](https://firebase.google.com/)
* [React-Quill](https://openbase.com/js/react-quill/documentation)
* [Material UI](https://material-ui.com/)
* [Bootstrap 4](https://getbootstrap.com/docs/4.0/getting-started/introduction/)
* [Deployed on Netlify](https://www.netlify.com/)

### Getting Started

To get a local copy up and running follow these simple steps.

#### Prerequisites

This is an example of how to list things you need to use the software and how to install them.

* npm

  ```
  npm install npm@latest -g
  ```

#### Installation

1. Clone the repo

   ```
   git clone https://github.com/juniHub/dev-note-v2.git
   ```
2. Install NPM packages

   ```
   npm install
   ```
3. Connect to your firebase and add info in

   ```
   .env
   ```
4. Run the project locally on <http://localhost:3000>

   ```
   npm run start
   ```

### Usage

*For more examples, please refer to the* [*Documentation*](https://junitiennguyen.gitbook.io/taking-notes/)*. This will be continued for update and maintainance.*

### Roadmap

See the [open issues](https://github.com/juniHub/dev-note-v2/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 learned, inspired, and created. 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

Juni Nguyen - [helloJuni](https://hellojuninguyen.netlify.app/)

Project Link: <https://github.com/juniHub/dev-note-v2>

### Acknowledgements

Inspired by evernote clone project from [Zack Wilson (PortEXE)](https://www.youtube.com/watch?v=I250xdtUvy8)