VIR1-CORE

Explore the docs

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Using in you project
3. Hacking on the project
4. Roadmap
5. Documentation
6. Contributing
7. License
8. Contact

About The Project

This is a project that provides classes that will be used by all the developers of other VIR1 modules. The goal of this project is to regroup all the code that would otherwise be duplicated.

Built With

• NodeJS
• AWS NodeJS SDK
• Log4js
• Jest

Getting Started

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

Prerequisites

Before cloning this project, make sure you have the following packages/programs installed on your system:

• NodeJS
• Npm

Before you clone this repository, setup your AWS credentials so our classes can connect to the AWS servers.

Installation

1. Clone the repo

   git clone https://github.com/Thynkon/VIR1-CORE.git
   cd VIR1-CORE

2. Install npm dependencies

   npm install --dev

Using in your project

1. Add this package to your package.json

   npm install vir1-core

2. Checkout the unit tests under src/tests to know how to use the methods provided by this package.

Hacking on the project

Tests

If you have added a feature and you want to test if everything is ok, you can run the unit tests we wrote by typing the following:

npm test

Roadmap

See the open issues for a list of proposed features (and known issues).

Documentation

You can find under the doc directory, diagrams related to the classes used in this project as well as some decisions that were made.

Also, there is a wiki section that explains pretty much everything you need to understand about this repository.

If you want to look at the api documentation, you can generate it on your machine by typing the following:

npm run doc

The documentation will be generated in the doc/api folder.

Contributing

Contributions are what make the open source community such an amazing place to 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

• Thynkon

Project Link: https://github.com/Thynkon/VIR1-CORE