nramc/my-notes

Personal Knowledge Management System (PKMS). The Ultimate Playbook for developers with coding snippets, references, procedures and How-To guides crafted with real time experience.

Personal Knowledge Management System—My Notes

The Ultimate Playbook for developers with coding snippets, references, procedures and How-To guides crafted with real time experience.

Getting Started

Please find the below steps to set up and run application in your workstation.

Prerequisites

Application uses MkDocs, please refer MkDocs Installation for base setup.

Installation

1. Download Repository

   git clone https://github.com/nramc/my-notes.git 

2. Setup Virtual Environment

   python3 -m venv dev 

3. Install required dependencies

      source dev/bin/activate
      pip install -r requirements.txt
      export DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib

4. Run Application

     python -m mkdocs serve

5. Open up http://127.0.0.1:8000/ in your browser, and you'll see the home page being displayed

Contribution

Any contributions you make are greatly appreciated.

If you like the project and have a suggestion that would make this better, please fork the repo and create a pull request. You can also open an issue with the tag "enhancement."

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

Contact

Ramachandran Nellaiyappan

Credits

Sincere Thanks to following open source community for their wonderful efforts to make our life much easier.

• MkDocs: Project documentation with Markdown.
• MkDocs Material: Material Theme for MkDocs

Show your support

Give a ⭐️ if you like this project!