Timberyard

A simple and elegant way to utilize the console in node.js applications with minimal additional dependencies.


View Code · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

There are lots of logging libraries out there, but they all come with using additional libraries. Timberyard has minimal dependencies and works utilizing core logging technology provided by JavaScript.

This project is still in its early stages, but it works for creating simple logs in the console. Eventually I would like to develop a way to log to a file, and a way to "ship" logs through an email to notify users when important logs occur.

Built With

• TypeScript

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

git clone https://github.com/rrozema12/Project-Name.git

2. Install NPM packages

npm install

3. Build the module

npm run  build

3. Start the module

npm start

Usage

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

Your Name - @ryanrozema - rrozema2@gmail.com.com

Project Link: https://github.com/rrozema12/Timberyard