React Diary

A diary application created in react.

Explore the docs »

View Demo . Report Bug . Request Feature

Table Of Contents

• Table Of Contents
• About The Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
  • Creating A Pull Request
• License
• Authors
• Acknowledgements

About The Project

Built With

This project was built in React using Typescript.

• React-Router-Dom
• Material-UI
• React Simple MDE Editor
• React Markdown

Getting Started

Prerequisites

To get this project started you need the following pre-requisite libraries:

• React-Router-Dom
• Material-UI
• React Simple MDE Editor
• React Markdown

Installation

1. Clone the repo

git clone https://github.com/ShaanCoding/React-Diary.git

2. Install NPM packages

yarn add react-router-dom

yarn add @material-ui/core

yarn add --save react-simplemde-editor easymde

yarn add react-markdown

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.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

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 MPL 2.0 License. See LICENSE for more information.

Authors

• Shaan Khan - Comp Sci Student - Shaan Khan - Built ReadME Template

Acknowledgements

• ShaanCoding
• Othneil Drew
• ImgShields